com.vmware.nsx_policy package¶
Subpackages¶
- com.vmware.nsx_policy.aaa package
- com.vmware.nsx_policy.cluster package
- com.vmware.nsx_policy.infra package
- Subpackages
- com.vmware.nsx_policy.infra.domains package
- com.vmware.nsx_policy.infra.realized_state package
- Subpackages
- com.vmware.nsx_policy.infra.realized_state.enforcement_points package
- Subpackages
- Submodules
- com.vmware.nsx_policy.infra.realized_state.enforcement_points.firewalls_client module
- com.vmware.nsx_policy.infra.realized_state.enforcement_points.groups_client module
- com.vmware.nsx_policy.infra.realized_state.enforcement_points.ip_sets_client module
- com.vmware.nsx_policy.infra.realized_state.enforcement_points.mac_sets_client module
- com.vmware.nsx_policy.infra.realized_state.enforcement_points.services_client module
- com.vmware.nsx_policy.infra.realized_state.enforcement_points package
- Submodules
- com.vmware.nsx_policy.infra.realized_state.enforcement_points_client module
- Subpackages
- com.vmware.nsx_policy.infra.tier_0s package
- Subpackages
- com.vmware.nsx_policy.infra.tier_0s.locale_services package
- Subpackages
- Submodules
- com.vmware.nsx_policy.infra.tier_0s.locale_services.bgp_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.byod_service_instances_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.endpoints_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.l2vpn_context_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services.l3vpns_client module
- com.vmware.nsx_policy.infra.tier_0s.locale_services package
- Submodules
- com.vmware.nsx_policy.infra.tier_0s.locale_services_client module
- Subpackages
- com.vmware.nsx_policy.infra.tier_1s package
- Submodules
- com.vmware.nsx_policy.infra.deployment_zones_client module
- com.vmware.nsx_policy.infra.domains_client module
- com.vmware.nsx_policy.infra.partner_services_client module
- com.vmware.nsx_policy.infra.realized_state_client module
- com.vmware.nsx_policy.infra.services_client module
- com.vmware.nsx_policy.infra.tier_0s_client module
- com.vmware.nsx_policy.infra.tier_1s_client module
- Subpackages
Submodules¶
com.vmware.nsx_policy.aaa_client module¶
-
class
com.vmware.nsx_policy.aaa_client.RegistrationToken(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
create()¶ The privileges of the registration token will be the same as the caller.
Return type: com.vmware.nsx_policy.model_client.RegistrationTokenReturns: com.vmware.nsx_policy.model.RegistrationToken Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
delete(token)¶ Delete registration access token
Parameters: token ( str) – Registration token (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(token)¶ Get registration access token
Parameters: token ( str) – Registration token (required)Return type: com.vmware.nsx_policy.model_client.RegistrationTokenReturns: com.vmware.nsx_policy.model.RegistrationToken Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.aaa_client.RoleBindings(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
LIST_TYPE_LOCAL_USER= 'local_user'¶ Possible value for
typeof methodRoleBindings.list().
-
LIST_TYPE_PRINCIPAL_IDENTITY= 'principal_identity'¶ Possible value for
typeof methodRoleBindings.list().
-
LIST_TYPE_REMOTE_GROUP= 'remote_group'¶ Possible value for
typeof methodRoleBindings.list().
-
LIST_TYPE_REMOTE_USER= 'remote_user'¶ Possible value for
typeof methodRoleBindings.list().
-
create(role_binding)¶ Assign roles to User or Group
Parameters: role_binding ( com.vmware.nsx_policy.model_client.RoleBinding) – (required)Return type: com.vmware.nsx_policy.model_client.RoleBindingReturns: com.vmware.nsx_policy.model.RoleBinding Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
delete(binding_id)¶ Delete user/group’s roles assignment
Parameters: binding_id ( str) – User/Group’s id (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
deletestalebindings()¶ Delete all stale role assignments
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(binding_id)¶ Get user/group’s role information
Parameters: binding_id ( str) – User/Group’s id (required)Return type: com.vmware.nsx_policy.model_client.RoleBindingReturns: com.vmware.nsx_policy.model.RoleBinding Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, name=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶ Get all users and groups with their roles
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - name (
strorNone) – User/Group name (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional) - type (
strorNone) – Type (optional)
Return type: Returns: com.vmware.nsx_policy.model.RoleBindingListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
update(binding_id, role_binding)¶ Update User or Group’s roles
Parameters: - binding_id (
str) – User/Group’s id (required) - role_binding (
com.vmware.nsx_policy.model_client.RoleBinding) – (required)
Return type: Returns: com.vmware.nsx_policy.model.RoleBinding
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- binding_id (
-
-
class
com.vmware.nsx_policy.aaa_client.Roles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(role)¶ Get role information
Parameters: role ( str) – Role Name (required)Return type: com.vmware.nsx_policy.model_client.RoleWithFeaturesReturns: com.vmware.nsx_policy.model.RoleWithFeatures Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list()¶ Get information about all roles
Return type: com.vmware.nsx_policy.model_client.RoleListResultReturns: com.vmware.nsx_policy.model.RoleListResult Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.aaa_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
-
class
com.vmware.nsx_policy.aaa_client.UserInfo(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Get information about logged-in user. The permissions parameter of the NsxRole has been deprecated.
Return type: com.vmware.nsx_policy.model_client.UserInfoReturns: com.vmware.nsx_policy.model.UserInfo Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
com.vmware.nsx_policy.cluster_client module¶
-
class
com.vmware.nsx_policy.cluster_client.Backups(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
retrievesshfingerprint(remote_server_fingerprint_request)¶ Get SHA256 fingerprint of ECDSA key of remote server. The caller should independently verify that the key is trusted.
Parameters: remote_server_fingerprint_request ( com.vmware.nsx_policy.model_client.RemoteServerFingerprintRequest) – (required)Return type: com.vmware.nsx_policy.model_client.RemoteServerFingerprintReturns: com.vmware.nsx_policy.model.RemoteServerFingerprint Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.cluster_client.Nodes(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
CREATE_ACTION_NODE= 'add_cluster_node'¶ Possible value for
actionof methodNodes.create().
-
create(add_cluster_node_spec, action)¶ Adds a new controller node to the NSX cluster.
Parameters: - add_cluster_node_spec (
com.vmware.nsx_policy.model_client.AddClusterNodeSpec) – (required) - action (
str) – (required)
Return type: Returns: com.vmware.nsx_policy.model.ClusterNodeConfig
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- add_cluster_node_spec (
-
delete(node_id)¶ Removes the specified controller node from the NSX cluster. Before you can remove a controller node from the cluster, you must shut down the controller service with the "stop service controller" command.
Parameters: node_id ( str) – (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(node_id)¶ Returns information about the specified NSX cluster node.
Parameters: node_id ( str) – (required)Return type: com.vmware.nsx_policy.model_client.ClusterNodeConfigReturns: com.vmware.nsx_policy.model.ClusterNodeConfig Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Returns information about all NSX cluster nodes.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.ClusterNodeConfigListResultReturns: com.vmware.nsx_policy.model.ClusterNodeConfigListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.cluster_client.Restore(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
advance(advance_cluster_restore_request)¶ Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.
Parameters: advance_cluster_restore_request ( com.vmware.nsx_policy.model_client.AdvanceClusterRestoreRequest) – (required)Return type: com.vmware.nsx_policy.model_client.ClusterRestoreStatusReturns: com.vmware.nsx_policy.model.ClusterRestoreStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.ConcurrentChangeConflictRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
cancel()¶ Cancel any currently running restore operation. If there exists a currently running step, it is allowed to finish. The system is not rolled back to the pre-restore state. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING or SUSPENDED. Otherwise, a 409 response is returned.
Return type: com.vmware.nsx_policy.model_client.ClusterRestoreStatusReturns: com.vmware.nsx_policy.model.ClusterRestoreStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.ConcurrentChangeConflictRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
retry()¶ Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.
Return type: com.vmware.nsx_policy.model_client.ClusterRestoreStatusReturns: com.vmware.nsx_policy.model.ClusterRestoreStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.ConcurrentChangeConflictRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
start(initiate_cluster_restore_request)¶ Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.
Parameters: initiate_cluster_restore_request ( com.vmware.nsx_policy.model_client.InitiateClusterRestoreRequest) – (required)Return type: com.vmware.nsx_policy.model_client.ClusterRestoreStatusReturns: com.vmware.nsx_policy.model.ClusterRestoreStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.ConcurrentChangeConflictRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
suspend()¶ Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.
Return type: com.vmware.nsx_policy.model_client.ClusterRestoreStatusReturns: com.vmware.nsx_policy.model.ClusterRestoreStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.ConcurrentChangeConflictRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.cluster_client.Status(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
GET_SOURCE_CACHED= 'cached'¶ Possible value for
sourceof methodStatus.get().
-
GET_SOURCE_REALTIME= 'realtime'¶ Possible value for
sourceof methodStatus.get().
-
get(source=None)¶ Returns status information for the NSX cluster control role and management role.
Parameters: source ( strorNone) – Data source type. (optional)Return type: com.vmware.nsx_policy.model_client.ClusterStatusReturns: com.vmware.nsx_policy.model.ClusterStatus Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.cluster_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.configs_client module¶
-
class
com.vmware.nsx_policy.configs_client.Management(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Returns the NSX Management nodes global configuration.
Return type: com.vmware.nsx_policy.model_client.ManagementConfigReturns: com.vmware.nsx_policy.model.ManagementConfig Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
update(management_config)¶ Modifies the NSX Management nodes global configuration.
Parameters: management_config ( com.vmware.nsx_policy.model_client.ManagementConfig) – (required)Return type: com.vmware.nsx_policy.model_client.ManagementConfigReturns: com.vmware.nsx_policy.model.ManagementConfig Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.configs_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.enforcement_points_client module¶
-
class
com.vmware.nsx_policy.enforcement_points_client.ServiceDefinitions(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
create(enforcement_point_id, service_definition)¶ Create a Service Definition on given enforcement point.
Parameters: - enforcement_point_id (
str) – Enforcement point id (required) - service_definition (
com.vmware.nsx_policy.model_client.ServiceDefinition) – (required)
Return type: Returns: com.vmware.nsx_policy.model.ServiceDefinition
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- enforcement_point_id (
-
delete(enforcement_point_id, service_definition_id)¶ Delete an existing Service Definition on the given enforcement point.
Parameters: - enforcement_point_id (
str) – Enforcement point id (required) - service_definition_id (
str) – Id of service definition (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- enforcement_point_id (
-
get(enforcement_point_id, service_definition_id)¶ Read Service Definition with given service-definition-id.
Parameters: - enforcement_point_id (
str) – Enforcement point id (required) - service_definition_id (
str) – Id of service definition (required)
Return type: Returns: com.vmware.nsx_policy.model.ServiceDefinition
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- enforcement_point_id (
-
list(enforcement_point_id)¶ List all Service Definitions registered on given enforcement point.
Parameters: enforcement_point_id ( str) – Enforcement point id (required)Return type: com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResultReturns: com.vmware.nsx_policy.model.ServiceInsertionServiceListResult Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
update(enforcement_point_id, service_definition_id, service_definition)¶ Update an existing Service Definition on the given enforcement point.
Parameters: - enforcement_point_id (
str) – Enforcement point id (required) - service_definition_id (
str) – Id of service definition (required) - service_definition (
com.vmware.nsx_policy.model_client.ServiceDefinition) – (required)
Return type: Returns: com.vmware.nsx_policy.model.ServiceDefinition
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- enforcement_point_id (
-
-
class
com.vmware.nsx_policy.enforcement_points_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.eula_client module¶
-
class
com.vmware.nsx_policy.eula_client.Accept(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
create()¶ Accept end user license agreement
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.eula_client.Acceptance(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Return the acceptance status of end user license agreement
Return type: com.vmware.nsx_policy.model_client.EULAAcceptanceReturns: com.vmware.nsx_policy.model.EULAAcceptance Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.eula_client.Content(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(cursor=None, format=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Return the content of end user license agreement in the specified format. By default, it’s pure string without line break
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - format (
strorNone) – End User License Agreement content output format (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.EULAContent
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.eula_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.infra_client module¶
-
class
com.vmware.nsx_policy.infra_client.Certificates(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
LIST_TYPE_CERTIFICATE= 'cluster_api_certificate'¶ Possible value for
typeof methodCertificates.list().
-
delete(certificate_id)¶ Removes the specified certificate. The private key associated with the certificate is also deleted.
Parameters: certificate_id ( str) – ID of certificate to delete (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(certificate_id, details=None)¶ Returns information for the specified certificate ID, including the certificate’s id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - certificate_id (
str) – ID of certificate to read (required) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false)
Return type: Returns: com.vmware.nsx_policy.model.TlsCertificate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- certificate_id (
-
list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶ Returns all certificate information viewable by the user, including each certificate’s id; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional) - type (
strorNone) – Type of certificate to return (optional)
Return type: Returns: com.vmware.nsx_policy.model.TlsCertificateList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(certificate_id, tls_trust_data)¶ Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate. This patch method does not modify an existing certificate.
Parameters: - certificate_id (
str) – (required) - tls_trust_data (
com.vmware.nsx_policy.model_client.TlsTrustData) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- certificate_id (
-
update(certificate_id, tls_trust_data)¶ Adds a new private-public certificate and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store. A certificate chain will not be expanded into separate certificate instances for reference, but would be pushed to the enforcement point as a single certificate.
Parameters: - certificate_id (
str) – (required) - tls_trust_data (
com.vmware.nsx_policy.model_client.TlsTrustData) – (required)
Return type: Returns: com.vmware.nsx_policy.model.TlsCertificate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- certificate_id (
-
-
class
com.vmware.nsx_policy.infra_client.Constraints(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(constraint_id)¶ Delete tenant constraint.
Parameters: constraint_id ( str) – (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(constraint_id)¶ Read tenant constraint.
Parameters: constraint_id ( str) – (required)Return type: com.vmware.nsx_policy.model_client.ConstraintReturns: com.vmware.nsx_policy.model.Constraint Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ List tenant constraints.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.ConstraintListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(constraint_id, constraint)¶ Create tenant constraint if not exists, otherwise update the existing constraint.
Parameters: - constraint_id (
str) – (required) - constraint (
com.vmware.nsx_policy.model_client.Constraint) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- constraint_id (
-
update(constraint_id, constraint)¶ Create tenant constraint if it does not exist, otherwise replace the existing constraint.
Parameters: - constraint_id (
str) – (required) - constraint (
com.vmware.nsx_policy.model_client.Constraint) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Constraint
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- constraint_id (
-
-
class
com.vmware.nsx_policy.infra_client.DeploymentZones(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(deployment_zone_id)¶ Read a Deployment Zone
Parameters: deployment_zone_id ( str) – Deployment Zone id (required)Return type: com.vmware.nsx_policy.model_client.DeploymentZoneReturns: com.vmware.nsx_policy.model.DeploymentZone Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all Deployment zones for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.DeploymentZoneListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.infra_client.DnsForwarderZones(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(dns_forwarder_zone_id)¶ Delete the DNS Forwarder Zone
Parameters: dns_forwarder_zone_id ( str) – DNS Forwarder Zone ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(dns_forwarder_zone_id)¶ Read the DNS Forwarder Zone
Parameters: dns_forwarder_zone_id ( str) – DNS Forwarder Zone ID (required)Return type: com.vmware.nsx_policy.model_client.PolicyDnsForwarderZoneReturns: com.vmware.nsx_policy.model.PolicyDnsForwarderZone Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all Dns Forwarder Zones
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.PolicyDnsForwarderZoneListResultReturns: com.vmware.nsx_policy.model.PolicyDnsForwarderZoneListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(dns_forwarder_zone_id, policy_dns_forwarder_zone)¶ Update the DNS Forwarder Zone
Parameters: - dns_forwarder_zone_id (
str) – DNS Forwarder Zone ID (required) - policy_dns_forwarder_zone (
com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- dns_forwarder_zone_id (
-
update(dns_forwarder_zone_id, policy_dns_forwarder_zone)¶ Update the DNS Forwarder Zone
Parameters: - dns_forwarder_zone_id (
str) – DNS Forwarder Zone ID (required) - policy_dns_forwarder_zone (
com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone) – (required)
Return type: Returns: com.vmware.nsx_policy.model.PolicyDnsForwarderZone
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- dns_forwarder_zone_id (
-
-
class
com.vmware.nsx_policy.infra_client.Domains(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(domain_id)¶ Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.
Parameters: domain_id ( str) – Domain ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(domain_id)¶ Read a domain.
Parameters: domain_id ( str) – Domain ID (required)Return type: com.vmware.nsx_policy.model_client.DomainReturns: com.vmware.nsx_policy.model.Domain Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all domains for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.DomainListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(domain_id, domain)¶ If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain
Parameters: - domain_id (
str) – Domain ID (required) - domain (
com.vmware.nsx_policy.model_client.Domain) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- domain_id (
-
update(domain_id, domain)¶ If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. This is a full replace
Parameters: - domain_id (
str) – Domain ID (required) - domain (
com.vmware.nsx_policy.model_client.Domain) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Domain
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- domain_id (
-
-
class
com.vmware.nsx_policy.infra_client.IpfixCollectorProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(ipfix_collector_profile_id)¶ API deletes IPFIX collector profile. Flow forwarding to collector will be stopped.
Parameters: ipfix_collector_profile_id ( str) – IPFIX collector Profile id (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(ipfix_collector_profile_id)¶ API will return details of IPFIX collector profile. If profile does not exist, it will return 404.
Parameters: ipfix_collector_profile_id ( str) – IPFIX collector profile id (required)Return type: com.vmware.nsx_policy.model_client.IPFIXCollectorProfileReturns: com.vmware.nsx_policy.model.IPFIXCollectorProfile Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ API will provide list of all IPFIX collector profiles and their details.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.IPFIXCollectorProfileListResultReturns: com.vmware.nsx_policy.model.IPFIXCollectorProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(ipfix_collector_profile_id, i_pfix_collector_profile)¶ Create a new IPFIX collector profile if the IPFIX collector profile with given id does not already exist. If the IPFIX collector profile with the given id already exists, patch with the existing IPFIX collector profile.
Parameters: - ipfix_collector_profile_id (
str) – IPFIX collector profile id (required) - i_pfix_collector_profile (
com.vmware.nsx_policy.model_client.IPFIXCollectorProfile) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_collector_profile_id (
-
update(ipfix_collector_profile_id, i_pfix_collector_profile)¶ Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX collector port.
Parameters: - ipfix_collector_profile_id (
str) – IPFIX collector profile id (required) - i_pfix_collector_profile (
com.vmware.nsx_policy.model_client.IPFIXCollectorProfile) – (required)
Return type: Returns: com.vmware.nsx_policy.model.IPFIXCollectorProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_collector_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.IpfixDfwCollectorProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(ipfix_dfw_collector_profile_id)¶ API deletes IPFIX dfw collector profile. Flow forwarding to collector will be stopped.
Parameters: ipfix_dfw_collector_profile_id ( str) – IPFIX dfw collector Profile id (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(ipfix_dfw_collector_profile_id)¶ API will return details of IPFIX dfw collector profile. If profile does not exist, it will return 404.
Parameters: ipfix_dfw_collector_profile_id ( str) – IPFIX dfw collector profile id (required)Return type: com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileReturns: com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ API will provide list of all IPFIX dfw collector profiles and their details.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResultReturns: com.vmware.nsx_policy.model.IPFIXDFWCollectorProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)¶ Create a new IPFIX dfw collector profile if the IPFIX dfw collector profile with given id does not already exist. If the IPFIX dfw collector profile with the given id already exists, patch with the existing IPFIX dfw collector profile.
Parameters: - ipfix_dfw_collector_profile_id (
str) – (required) - i_pfixdfw_collector_profile (
com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_dfw_collector_profile_id (
-
update(ipfix_dfw_collector_profile_id, i_pfixdfw_collector_profile)¶ Create or Replace IPFIX dfw collector profile. IPFIX data will be sent to IPFIX collector port.
Parameters: - ipfix_dfw_collector_profile_id (
str) – IPFIX dfw collector profile id (required) - i_pfixdfw_collector_profile (
com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile) – (required)
Return type: Returns: com.vmware.nsx_policy.model.IPFIXDFWCollectorProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_dfw_collector_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.IpfixDfwProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(ipfix_dfw_profile_id)¶ API deletes IPFIX DFW Profile. Selected IPFIX Collectors will stop receiving flows.
Parameters: ipfix_dfw_profile_id ( str) – IPFIX DFW Profile ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(ipfix_dfw_profile_id)¶ API will return details of IPFIX DFW profile.
Parameters: ipfix_dfw_profile_id ( str) – IPFIX DFW collection id (required)Return type: com.vmware.nsx_policy.model_client.IPFIXDFWProfileReturns: com.vmware.nsx_policy.model.IPFIXDFWProfile Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ API provides list IPFIX DFW profiles available on selected logical DFW.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResultReturns: com.vmware.nsx_policy.model.IPFIXDFWProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(ipfix_dfw_profile_id, i_pfixdfw_profile)¶ Create a new IPFIX DFW profile if the IPFIX DFW profile with given id does not already exist. If the IPFIX DFW profile with the given id already exists, patch with the existing IPFIX DFW profile.
Parameters: - ipfix_dfw_profile_id (
str) – IPFIX DFW Profile ID (required) - i_pfixdfw_profile (
com.vmware.nsx_policy.model_client.IPFIXDFWProfile) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_dfw_profile_id (
-
update(ipfix_dfw_profile_id, i_pfixdfw_profile)¶ Create or replace IPFIX DFW profile. Config will start forwarding data to provided IPFIX DFW collector.
Parameters: - ipfix_dfw_profile_id (
str) – IPFIX DFW Profile ID (required) - i_pfixdfw_profile (
com.vmware.nsx_policy.model_client.IPFIXDFWProfile) – (required)
Return type: Returns: com.vmware.nsx_policy.model.IPFIXDFWProfile
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- ipfix_dfw_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.Labels(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(label_id)¶ Delete PolicyLabel object
Parameters: label_id ( str) – (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(label_id)¶ Read a label.
Parameters: label_id ( str) – (required)Return type: com.vmware.nsx_policy.model_client.PolicyLabelReturns: com.vmware.nsx_policy.model.PolicyLabel Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all labels for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.PolicyLabelListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(label_id, policy_label)¶ Create label if not exists, otherwise take the partial updates. Note, once the label is created type attribute can not be changed.
Parameters: - label_id (
str) – (required) - policy_label (
com.vmware.nsx_policy.model_client.PolicyLabel) – (required)
Return type: Returns: com.vmware.nsx_policy.model.PolicyLabel
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- label_id (
-
update(label_id, policy_label)¶ Create label if not exists, otherwise replaces the existing label. If label already exists then type attribute cannot be changed.
Parameters: - label_id (
str) – (required) - policy_label (
com.vmware.nsx_policy.model_client.PolicyLabel) – (required)
Return type: Returns: com.vmware.nsx_policy.model.PolicyLabel
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- label_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbAppProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_app_profile_id, force=None)¶ Delete the LBAppProfile along with all the entities contained by this LBAppProfile.
Parameters: - lb_app_profile_id (
str) – LBAppProfile ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_app_profile_id (
-
get(lb_app_profile_id)¶ Read a LBAppProfile.
Parameters: lb_app_profile_id ( str) – LBAppProfile ID (required)Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBAppProfile The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.LBAppProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBAppProfiles
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.LBAppProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_app_profile_id, lb_app_profile)¶ If a LBAppProfile with the lb-app-profile-id is not already present, create a new LBAppProfile. If it already exists, update the LBAppProfile. This is a full replace
Parameters: - lb_app_profile_id (
str) – LBAppProfile ID (required) - lb_app_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBAppProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_app_profile_id (
-
update(lb_app_profile_id, lb_app_profile)¶ If a LBAppProfile with the lb-app-profile-id is not already present, create a new LBAppProfile. If it already exists, update the LBAppProfile. This is a full replace
Parameters: - lb_app_profile_id (
str) – LBAppProfile ID (required) - lb_app_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBAppProfile.
Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBAppProfile The return value will contain all the attributes defined in
com.vmware.nsx_policy.model_client.LBAppProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_app_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbClientSslProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(lb_client_ssl_profile_id)¶ Read a LBClientSslProfile.
Parameters: lb_client_ssl_profile_id ( str) – LBClientSslProfile ID (required)Return type: com.vmware.nsx_policy.model_client.LBClientSslProfileReturns: com.vmware.nsx_policy.model.LBClientSslProfile Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBClientSslProfiles
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.LBClientSslProfileListResultReturns: com.vmware.nsx_policy.model.LBClientSslProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.infra_client.LbMonitorProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_monitor_profile_id, force=None)¶ Delete the LBMonitorProfile along with all the entities contained by this LBMonitorProfile.
Parameters: - lb_monitor_profile_id (
str) – LBMonitorProfile ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_monitor_profile_id (
-
get(lb_monitor_profile_id)¶ Read a LBMonitorProfile.
Parameters: lb_monitor_profile_id ( str) – LBMonitorProfile ID (required)Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBMonitorProfile The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.LBMonitorProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBMonitorProfiles for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.LBMonitorProfileListResultReturns: com.vmware.nsx_policy.model.LBMonitorProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_monitor_profile_id, lb_monitor_profile)¶ If a LBMonitorProfile with the lb-monitor-profile-id is not already present, create a new LBMonitorProfile. If it already exists, update the LBMonitorProfile. This is a full replace
Parameters: - lb_monitor_profile_id (
str) – LBMonitorProfile ID (required) - lb_monitor_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBMonitorProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_monitor_profile_id (
-
update(lb_monitor_profile_id, lb_monitor_profile)¶ If a LBMonitorProfile with the lb-monitor-profile-id is not already present, create a new LBMonitorProfile. If it already exists, update the LBMonitorProfile. This is a full replace
Parameters: - lb_monitor_profile_id (
str) – LBMonitorProfile ID (required) - lb_monitor_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBMonitorProfile.
Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBMonitorProfile The return value will contain all the attributes defined in
com.vmware.nsx_policy.model_client.LBMonitorProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_monitor_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbPersistenceProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_persistence_profile_id, force=None)¶ Delete the LBPersistenceProfile along with all the entities contained by this LBPersistenceProfile.
Parameters: - lb_persistence_profile_id (
str) – LBPersistenceProfile ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_persistence_profile_id (
-
get(lb_persistence_profile_id)¶ Read a LBPersistenceProfile.
Parameters: lb_persistence_profile_id ( str) – LBPersistenceProfile ID (required)Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBPersistenceProfile The return value will contain all the attributes defined in com.vmware.nsx_policy.model_client.LBPersistenceProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBPersistenceProfiles for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.LBPersistenceProfileListResultReturns: com.vmware.nsx_policy.model.LBPersistenceProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_persistence_profile_id, lb_persistence_profile)¶ If a LBPersistenceProfile with the lb-persistence-profile-id is not already present, create a new LBPersistenceProfile. If it already exists, update the LBPersistenceProfile. This is a full replace
Parameters: - lb_persistence_profile_id (
str) – LBPersistenceProfile ID (required) - lb_persistence_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBPersistenceProfile.
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_persistence_profile_id (
-
update(lb_persistence_profile_id, lb_persistence_profile)¶ If a LBPersistenceProfile with the lb-persistence-profile-id is not already present, create a new LBPersistenceProfile. If it already exists, update the LBPersistenceProfile. This is a full replace
Parameters: - lb_persistence_profile_id (
str) – LBPersistenceProfile ID (required) - lb_persistence_profile (
vmware.vapi.struct.VapiStruct) – (required) The parameter must contain all the attributes defined incom.vmware.nsx_policy.model_client.LBPersistenceProfile.
Return type: vmware.vapi.struct.VapiStructReturns: com.vmware.nsx_policy.model.LBPersistenceProfile The return value will contain all the attributes defined in
com.vmware.nsx_policy.model_client.LBPersistenceProfile.Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_persistence_profile_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbPools(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_pool_id, force=None)¶ Delete the LBPool along with all the entities contained by this LBPool.
Parameters: - lb_pool_id (
str) – LBPool ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_pool_id (
-
get(lb_pool_id)¶ Read a LBPool.
Parameters: lb_pool_id ( str) – LBPool ID (required)Return type: com.vmware.nsx_policy.model_client.LBPoolReturns: com.vmware.nsx_policy.model.LBPool Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBPooles
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.LBPoolListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_pool_id, lb_pool)¶ If a LBPool with the lb-pool-id is not already present, create a new LBPool. If it already exists, update the LBPool. This is a full replace
Parameters: - lb_pool_id (
str) – LBPool ID (required) - lb_pool (
com.vmware.nsx_policy.model_client.LBPool) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_pool_id (
-
update(lb_pool_id, lb_pool)¶ If a LBPool with the lb-pool-id is not already present, create a new LBPool. If it already exists, update the LBPool. This is a full replace
Parameters: - lb_pool_id (
str) – LBPool ID (required) - lb_pool (
com.vmware.nsx_policy.model_client.LBPool) – (required)
Return type: Returns: com.vmware.nsx_policy.model.LBPool
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_pool_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbServerSslProfiles(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(lb_server_ssl_profile_id)¶ Read a LBServerSslProfile.
Parameters: lb_server_ssl_profile_id ( str) – LBServerSslProfile ID (required)Return type: com.vmware.nsx_policy.model_client.LBServerSslProfileReturns: com.vmware.nsx_policy.model.LBServerSslProfile Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBServerSslProfiles
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.LBServerSslProfileListResultReturns: com.vmware.nsx_policy.model.LBServerSslProfileListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.infra_client.LbServices(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_service_id, force=None)¶ Delete the LBService along with all the entities contained by this LBService.
Parameters: - lb_service_id (
str) – LBService ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_service_id (
-
get(lb_service_id)¶ Read a LBService.
Parameters: lb_service_id ( str) – LBService ID (required)Return type: com.vmware.nsx_policy.model_client.LBServiceReturns: com.vmware.nsx_policy.model.LBService Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBService
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.LBServiceListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_service_id, lb_service)¶ If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace
Parameters: - lb_service_id (
str) – LBService ID (required) - lb_service (
com.vmware.nsx_policy.model_client.LBService) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_service_id (
-
update(lb_service_id, lb_service)¶ If a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace
Parameters: - lb_service_id (
str) – LBService ID (required) - lb_service (
com.vmware.nsx_policy.model_client.LBService) – (required)
Return type: Returns: com.vmware.nsx_policy.model.LBService
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_service_id (
-
-
class
com.vmware.nsx_policy.infra_client.LbVirtualServers(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(lb_virtual_server_id, force=None)¶ Delete the LBVirtualServer along with all the entities contained by this LBVirtualServer.
Parameters: - lb_virtual_server_id (
str) – LBVirtualServer ID (required) - force (
boolorNone) – Force delete the resource even if it is being used somewhere (optional, default to false)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_virtual_server_id (
-
get(lb_virtual_server_id)¶ Read a LBVirtualServer.
Parameters: lb_virtual_server_id ( str) – LBVirtualServer ID (required)Return type: com.vmware.nsx_policy.model_client.LBVirtualServerReturns: com.vmware.nsx_policy.model.LBVirtualServer Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all LBVirtualServers
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.LBVirtualServerListResultReturns: com.vmware.nsx_policy.model.LBVirtualServerListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(lb_virtual_server_id, lb_virtual_server)¶ If a LBVirtualServer with the lb-virtual-server-id is not already present, create a new LBVirtualServer. If it already exists, update the LBVirtualServer. This is a full replace
Parameters: - lb_virtual_server_id (
str) – LBVirtualServer ID (required) - lb_virtual_server (
com.vmware.nsx_policy.model_client.LBVirtualServer) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_virtual_server_id (
-
update(lb_virtual_server_id, lb_virtual_server)¶ If a LBVirtualServer with the lb-virtual-server-id is not already present, create a new LBVirtualServer. If it already exists, update the LBVirtualServer. This is a full replace
Parameters: - lb_virtual_server_id (
str) – LBVirtualServer ID (required) - lb_virtual_server (
com.vmware.nsx_policy.model_client.LBVirtualServer) – (required)
Return type: Returns: com.vmware.nsx_policy.model.LBVirtualServer
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- lb_virtual_server_id (
-
-
class
com.vmware.nsx_policy.infra_client.PartnerServices(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(service_name)¶ Read the specific partner service identified by provided name.
Parameters: service_name ( str) – Name of the service (required)Return type: com.vmware.nsx_policy.model_client.ServiceDefinitionReturns: com.vmware.nsx_policy.model.ServiceDefinition Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Read all the partner services available for service insertion
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResultReturns: com.vmware.nsx_policy.model.ServiceInsertionServiceListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.infra_client.Services(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(service_id)¶ Delete Service
Parameters: service_id ( str) – Service ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(service_id)¶ Read a service
Parameters: service_id ( str) – Service ID (required)Return type: com.vmware.nsx_policy.model_client.ServiceReturns: com.vmware.nsx_policy.model.Service Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of Services for infra.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.ServiceListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(service_id, service)¶ Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.
Parameters: - service_id (
str) – Service ID (required) - service (
com.vmware.nsx_policy.model_client.Service) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- service_id (
-
update(service_id, service)¶ Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.
Parameters: - service_id (
str) – Service ID (required) - service (
com.vmware.nsx_policy.model_client.Service) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Service
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- service_id (
-
-
class
com.vmware.nsx_policy.infra_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
-
class
com.vmware.nsx_policy.infra_client.Tier0s(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(tier0_id)¶ Delete tier-0
Parameters: tier0_id ( str) – Tier-0 ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(tier0_id)¶ Read tier-0
Parameters: tier0_id ( str) – Tier-0 ID (required)Return type: com.vmware.nsx_policy.model_client.Tier0Returns: com.vmware.nsx_policy.model.Tier0 Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all Tier-0s
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.Tier0ListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(tier0_id, tier0)¶ If a tier-0 with the tier-0-id is not already present, create a new tier-0. If it already exists, update the tier-0 for specified attributes.
Parameters: - tier0_id (
str) – Tier-0 ID (required) - tier0 (
com.vmware.nsx_policy.model_client.Tier0) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- tier0_id (
-
update(tier0_id, tier0)¶ If a tier-0 with the tier-0-id is not already present, create a new tier-0. If it already exists, replace the tier-0 instance with the new object.
Parameters: - tier0_id (
str) – Tier-0 ID (required) - tier0 (
com.vmware.nsx_policy.model_client.Tier0) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Tier0
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- tier0_id (
-
-
class
com.vmware.nsx_policy.infra_client.Tier1s(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
delete(tier1_id)¶ Delete tier-1 configuration
Parameters: tier1_id ( str) – Tier-1 ID (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(tier1_id)¶ Read tier-1 configuration
Parameters: tier1_id ( str) – Tier-1 ID (required)Return type: com.vmware.nsx_policy.model_client.Tier1Returns: com.vmware.nsx_policy.model.Tier1 Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Paginated list of all tier-1 instances
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.Tier1ListResult
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
patch(tier1_id, tier1)¶ If tier-1 with the tier-1-id is not already present, create a new tier-1 instance. If it already exists, update the tier-1 instance with specified attributes.
Parameters: - tier1_id (
str) – Tier-1 ID (required) - tier1 (
com.vmware.nsx_policy.model_client.Tier1) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- tier1_id (
-
update(tier1_id, tier1)¶ If tier-1 with the tier-1-id is not already present, create a new tier-1 instance. If it already exists, replace the tier-1 instance with this object.
Parameters: - tier1_id (
str) – Tier-1 ID (required) - tier1 (
com.vmware.nsx_policy.model_client.Tier1) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Tier1
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- tier1_id (
-
com.vmware.nsx_policy.licenses_client module¶
-
class
com.vmware.nsx_policy.licenses_client.LicensesUsage(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Returns usage report of all registered modules
Return type: com.vmware.nsx_policy.model_client.FeatureUsageListReturns: com.vmware.nsx_policy.model.FeatureUsageList Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.licenses_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.model_client module¶
-
class
com.vmware.nsx_policy.model_client.ALGTypeNSService(alg=None, destination_ports=None, source_ports=None, resource_type='ALGTypeNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn NSService element that represents an ALG protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - alg (
str) –Possible values are:
ALGTypeNSService.ALG_ORACLE_TNSALGTypeNSService.ALG_FTPALGTypeNSService.ALG_SUN_RPC_TCPALGTypeNSService.ALG_SUN_RPC_UDPALGTypeNSService.ALG_MS_RPC_TCPALGTypeNSService.ALG_MS_RPC_UDPALGTypeNSService.ALG_NBNS_BROADCASTALGTypeNSService.ALG_NBDG_BROADCASTALGTypeNSService.ALG_TFTP
The Application Layer Gateway (ALG) protocol - destination_ports (
listofstrorNone) – The destination_port cannot be empty and must be a single value. format: port-or-range - source_ports (
listofstrorNone) – Source ports format: port-or-range - resource_type (
str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
-
ALG_FTP= 'FTP'¶
-
ALG_MS_RPC_TCP= 'MS_RPC_TCP'¶
-
ALG_MS_RPC_UDP= 'MS_RPC_UDP'¶
-
ALG_NBDG_BROADCAST= 'NBDG_BROADCAST'¶
-
ALG_NBNS_BROADCAST= 'NBNS_BROADCAST'¶
-
ALG_ORACLE_TNS= 'ORACLE_TNS'¶
-
ALG_SUN_RPC_TCP= 'SUN_RPC_TCP'¶
-
ALG_SUN_RPC_UDP= 'SUN_RPC_UDP'¶
-
ALG_TFTP= 'TFTP'¶
- alg (
-
class
com.vmware.nsx_policy.model_client.ALGTypeServiceEntry(alg=None, destination_ports=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ALGTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn ServiceEntry that represents an ALG protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - alg (
str) –Possible values are:
ALGTypeServiceEntry.ALG_ORACLE_TNSALGTypeServiceEntry.ALG_FTPALGTypeServiceEntry.ALG_SUN_RPC_TCPALGTypeServiceEntry.ALG_SUN_RPC_UDPALGTypeServiceEntry.ALG_MS_RPC_TCPALGTypeServiceEntry.ALG_MS_RPC_UDPALGTypeServiceEntry.ALG_NBNS_BROADCASTALGTypeServiceEntry.ALG_NBDG_BROADCASTALGTypeServiceEntry.ALG_TFTP
- destination_ports (
listofstrorNone) – The destination_port cannot be empty and must be a single value. format: port-or-range - source_ports (
listofstrorNone) – - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
ALG_FTP= 'FTP'¶
-
ALG_MS_RPC_TCP= 'MS_RPC_TCP'¶
-
ALG_MS_RPC_UDP= 'MS_RPC_UDP'¶
-
ALG_NBDG_BROADCAST= 'NBDG_BROADCAST'¶
-
ALG_NBNS_BROADCAST= 'NBNS_BROADCAST'¶
-
ALG_ORACLE_TNS= 'ORACLE_TNS'¶
-
ALG_SUN_RPC_TCP= 'SUN_RPC_TCP'¶
-
ALG_SUN_RPC_UDP= 'SUN_RPC_UDP'¶
-
ALG_TFTP= 'TFTP'¶
- alg (
-
class
com.vmware.nsx_policy.model_client.AbstractSpace(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, connectivity_strategy=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the space in which the policy is being defined
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - connectivity_strategy (
strorNone) –Possible values are:
AbstractSpace.CONNECTIVITY_STRATEGY_WHITELISTAbstractSpace.CONNECTIVITY_STRATEGY_BLACKLISTAbstractSpace.CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGINGAbstractSpace.CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGINGAbstractSpace.CONNECTIVITY_STRATEGY_NONE
This field indicates the default connectivity policy for the infra or tenant space WHITELIST - Adds a default drop rule. Administrator can then use "allow" rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use "drop" rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added. This is the default setting
-
CONNECTIVITY_STRATEGY_BLACKLIST= 'BLACKLIST'¶
-
CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING= 'BLACKLIST_ENABLE_LOGGING'¶
-
CONNECTIVITY_STRATEGY_NONE= 'NONE'¶
-
CONNECTIVITY_STRATEGY_WHITELIST= 'WHITELIST'¶
-
CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING= 'WHITELIST_ENABLE_LOGGING'¶
- links (
-
class
com.vmware.nsx_policy.model_client.AcceptableComponentVersion(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None, component_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - acceptable_versions (
listofstr) – List of component versions - component_type (
str) –Possible values are:
AcceptableComponentVersion.COMPONENT_TYPE_HOSTAcceptableComponentVersion.COMPONENT_TYPE_EDGEAcceptableComponentVersion.COMPONENT_TYPE_CCPAcceptableComponentVersion.COMPONENT_TYPE_MP
Node type
-
COMPONENT_TYPE_CCP= 'CCP'¶
-
COMPONENT_TYPE_EDGE= 'EDGE'¶
-
COMPONENT_TYPE_HOST= 'HOST'¶
-
COMPONENT_TYPE_MP= 'MP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.AcceptableComponentVersionList(results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: results ( listofAcceptableComponentVersion) – Acceptable version whitelist for different components
-
class
com.vmware.nsx_policy.model_client.ActionableResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructResources managed during restore process
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ip_address (
strorNone) – A resource reference on which actions can be performed format: ip
- links (
-
class
com.vmware.nsx_policy.model_client.ActionableResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofActionableResource) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.AddClusterNodeSpec(controller_role_config=None, display_name=None, external_id=None, mgr_role_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - controller_role_config (
AddControllerNodeSpecorNone) – - display_name (
strorNone) – Display name for the node - external_id (
strorNone) – External identifier of the node - mgr_role_config (
AddManagementNodeSpecorNone) –
- controller_role_config (
-
class
com.vmware.nsx_policy.model_client.AddControllerNodeSpec(clustering_params=None, control_plane_server_certificate=None, host_msg_client_info=None, mpa_msg_client_info=None, node_id=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - clustering_params (
ClusteringInfoorNone) – The details of the controller node required for cluster initialization or joining to an existing cluster. If this property is set, the node will be added to an existing cluster or used to create a new cluster. Otherwise no clustering operation/s will be performed. - control_plane_server_certificate (
strorNone) – Deprecated. Do not supply a value for this property. - host_msg_client_info (
MsgClientInfo) – - mpa_msg_client_info (
MsgClientInfo) – - node_id (
strorNone) – Only use this if an id for the node already exists with MP. If not specified, then the node_id will be set to a random id. - type (
str) –Possible values are:
must be set to AddControllerNodeSpec
-
TYPE_ADDCONTROLLERNODESPEC= 'AddControllerNodeSpec'¶
- clustering_params (
-
class
com.vmware.nsx_policy.model_client.AddManagementNodeSpec(cert_thumbprint=None, mpa_msg_client_info=None, password=None, remote_address=None, type=None, user_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cert_thumbprint (
strorNone) – The certificate thumbprint of the remote node. - mpa_msg_client_info (
MsgClientInfoorNone) – - password (
strorNone) – The password to be used to authenticate with the remote node. - remote_address (
str) – The host address of the remote node to which to send this join request. format: ip - type (
str) –Possible values are:
must be set to AddManagementNodeSpec - user_name (
str) – The username to be used to authenticate with the remote node.
-
TYPE_ADDMANAGEMENTNODESPEC= 'AddManagementNodeSpec'¶
- cert_thumbprint (
-
class
com.vmware.nsx_policy.model_client.AdvanceClusterRestoreInput(id=None, resources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - id (
strorNone) – Unique id of an instruction (as returned by the GET /restore/status call) for which input is to be provided This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resources (
listofSelectableResourceReference) – List of resources for which the instruction is applicable.
- id (
-
class
com.vmware.nsx_policy.model_client.AdvanceClusterRestoreRequest(data=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: data ( listofAdvanceClusterRestoreInput) – List of instructions and their associated data
-
class
com.vmware.nsx_policy.model_client.AdvertiseRule(action=None, description=None, display_name=None, networks=None, rule_filter=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
strorNone) –Possible values are:
ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.
- description (
strorNone) – Description - display_name (
strorNone) – Display name - networks (
listofstr) – network(CIDR) to be routed format: ipv4-cidr-block - rule_filter (
AdvertisementRuleFilterorNone) – Rule filter for the advertise rule
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DENY= 'DENY'¶
- action (
-
class
com.vmware.nsx_policy.model_client.AdvertiseRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rules (
listofAdvertiseRuleorNone) – List of advertisement rules
- links (
-
class
com.vmware.nsx_policy.model_client.AdvertisedNetwork(advertised_route_type=None, is_advertised=None, network=None, resource=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - advertised_route_type (
strorNone) – Advertise network route type on TIER0 LR This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_advertised (
boolorNone) – Flag to denote advertisement status of network to TIER0 LR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - network (
strorNone) – Advertised network address. format: ipv4 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource (
ResourceReferenceorNone) – Resource which has registered network.
- advertised_route_type (
-
class
com.vmware.nsx_policy.model_client.AdvertisedNetworksListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofAdvertisedNetworkorNone) – List of networks which advertised to TIER0 from TIER1 LR This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.AdvertisementConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advertise_lb_snat_ip=None, advertise_lb_vip=None, advertise_nat_routes=None, advertise_nsx_connected_routes=None, advertise_static_routes=None, enabled=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - advertise_lb_snat_ip (
boolorNone) – Flag to advertise all lb SNAT ips - advertise_lb_vip (
boolorNone) – Flag to advertise lb vip - advertise_nat_routes (
boolorNone) – Flag to advertise all routes of nat - advertise_nsx_connected_routes (
boolorNone) – Flag to advertise all connected routes - advertise_static_routes (
boolorNone) – Flag to advertise all static routes - enabled (
boolorNone) – Flag to enable this configuration - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.AdvertisementRuleFilter(match_route_types=None, prefix_operator=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTo filter the routes advertised by the TIER1 LR to TIER0 LR. Filtering will be based on the type of route and the prefix operator configured.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - match_route_types (
listofstr) –Possible values are:
AdvertisementRuleFilter.MATCH_ROUTE_TYPES_ANYAdvertisementRuleFilter.MATCH_ROUTE_TYPES_STATICAdvertisementRuleFilter.MATCH_ROUTE_TYPES_NSX_CONNECTEDAdvertisementRuleFilter.MATCH_ROUTE_TYPES_T1_NATAdvertisementRuleFilter.MATCH_ROUTE_TYPES_T1_LB_VIPAdvertisementRuleFilter.MATCH_ROUTE_TYPES_T1_LB_SNAT
Array of route types to filter routes - prefix_operator (
str) –Possible values are:
GE prefix operator filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.
-
MATCH_ROUTE_TYPES_ANY= 'ANY'¶
-
MATCH_ROUTE_TYPES_NSX_CONNECTED= 'NSX_CONNECTED'¶
-
MATCH_ROUTE_TYPES_STATIC= 'STATIC'¶
-
MATCH_ROUTE_TYPES_T1_LB_SNAT= 'T1_LB_SNAT'¶
-
MATCH_ROUTE_TYPES_T1_LB_VIP= 'T1_LB_VIP'¶
-
MATCH_ROUTE_TYPES_T1_NAT= 'T1_NAT'¶
-
PREFIX_OPERATOR_EQ= 'EQ'¶
-
PREFIX_OPERATOR_GE= 'GE'¶
- match_route_types (
-
class
com.vmware.nsx_policy.model_client.AggregateDataResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFinal data aggregation response. The results array holds the primary and the related objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofAggregateResponse) – Array containing the primary and the related object details
- links (
-
class
com.vmware.nsx_policy.model_client.AggregateL2VpnPeerConfig(l2vpn_path=None, l2vpn_peer_config_per_enforcement_point=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAggregate of L2Vpn peer config across Enforcement Points.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - l2vpn_path (
str) – Policy path referencing the L2Vpn. - l2vpn_peer_config_per_enforcement_point (
listofvmware.vapi.struct.VapiStructorNone) – List of L2Vpn peer config per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inL2VpnPeerConfigPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inL2VpnPeerConfigPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- l2vpn_path (
-
class
com.vmware.nsx_policy.model_client.AggregateL2VpnStatistics(intent_path=None, l2vpn_statistics_per_enforcement_point=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAggregate of L2Vpn Statistics across Enforcement Points.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - intent_path (
str) – Intent path of object, forward slashes must be escaped using %2F. - l2vpn_statistics_per_enforcement_point (
listofvmware.vapi.struct.VapiStructorNone) – List of L2Vpn Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inL2VpnStatisticsPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inL2VpnStatisticsPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- intent_path (
-
class
com.vmware.nsx_policy.model_client.AggregateL3VpnStatistics(intent_path=None, l3vpn_statistics_per_enforcement_point=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAggregate of L3Vpn Statistics across Enforcement Points.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - intent_path (
str) – Intent path of object, forward slashes must be escaped using %2F. - l3vpn_statistics_per_enforcement_point (
listofvmware.vapi.struct.VapiStructorNone) – List of L3Vpn Statistics per Enforcement Point. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inL3VpnStatisticsPerEnforcementPoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inL3VpnStatisticsPerEnforcementPoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- intent_path (
-
class
com.vmware.nsx_policy.model_client.AggregateRequest(included_fields=None, alias=None, filters=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCommon request parameters for the primary/related types
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - included_fields (
strorNone) – Comma separated list of fields that should be included in query result - alias (
strorNone) – Alias for the response - filters (
listofFilterRequestorNone) – An array of filter conditions - resource_type (
str) – Resource type name
- included_fields (
-
class
com.vmware.nsx_policy.model_client.AggregateResponse(primary=None, related=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructResponse for the primary/related types
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - primary (
vmware.vapi.struct.VapiStruct) – Requested properties of the primary object - related (
listofRelatedData) – Requested properties of the related objects
- primary (
-
class
com.vmware.nsx_policy.model_client.AllClusterGroupStatus(cluster_id=None, groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA list of the statuses of all the groups in the cluster.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - cluster_id (
strorNone) – UUID of the cluster This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - groups (
listofClusterGroupStatusorNone) – Array of groups and their statuses This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- cluster_id (
-
class
com.vmware.nsx_policy.model_client.AllocationIpAddress(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAllocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - allocation_id (
strorNone) – Address that is allocated from pool format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.AllocationIpAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofAllocationIpAddress) – Pool allocation list results
- links (
-
class
com.vmware.nsx_policy.model_client.ApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDetailed information about an API Error
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
strorNone) – Further details about the error - error_code (
longorNone) – A numeric error code format: int64 - error_data (
vmware.vapi.struct.VapiStructorNone) – Additional data about the error - error_message (
strorNone) – A description of the error - module_name (
strorNone) – The module name where the error occurred - related_errors (
listofRelatedApiErrororNone) – Other errors related to this error
- details (
-
class
com.vmware.nsx_policy.model_client.AppliedTos(logical_ports=None, logical_switches=None, nsgroups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEntity lists where the profile will be enabled on.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - logical_ports (
listofResourceReferenceorNone) – Logical Port List - logical_switches (
listofResourceReferenceorNone) – Logical Switch List - nsgroups (
listofResourceReferenceorNone) – NSGroup List
- logical_ports (
-
class
com.vmware.nsx_policy.model_client.AssignedByDhcp(resource_type='AssignedByDhcp')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis type can be specified in ip assignment spec of host switch if DHCP based IP assignment is desired for host switch virtual tunnel endpoints.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
-
class
com.vmware.nsx_policy.model_client.AssociationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofResourceReference) – Paged Collection of ResourceReference
- links (
-
class
com.vmware.nsx_policy.model_client.AttachmentContext(allocate_addresses=None, resource_type='AttachmentContext')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocate_addresses (
strorNone) –Possible values are:
AttachmentContext.ALLOCATE_ADDRESSES_IPPOOLAttachmentContext.ALLOCATE_ADDRESSES_MACPOOLAttachmentContext.ALLOCATE_ADDRESSES_BOTHAttachmentContext.ALLOCATE_ADDRESSES_NONE
A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
- resource_type (
str) – Used to identify which concrete class it is
-
ALLOCATE_ADDRESSES_BOTH= 'Both'¶
-
ALLOCATE_ADDRESSES_IPPOOL= 'IpPool'¶
-
ALLOCATE_ADDRESSES_MACPOOL= 'MacPool'¶
-
ALLOCATE_ADDRESSES_NONE= 'None'¶
- allocate_addresses (
-
class
com.vmware.nsx_policy.model_client.Attribute(attribute_type=None, display_name=None, key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAttribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - attribute_type (
strorNone) –Possible values are:
Attribute.ATTRIBUTE_TYPE_IP_ADDRESSAttribute.ATTRIBUTE_TYPE_PORTAttribute.ATTRIBUTE_TYPE_PASSWORDAttribute.ATTRIBUTE_TYPE_STRINGAttribute.ATTRIBUTE_TYPE_LONG
Attribute Type can be of any of the allowed enum type. - display_name (
strorNone) – Attribute display name string value. - key (
strorNone) – Attribute key string value. - value (
strorNone) – Attribute value string value.
-
ATTRIBUTE_TYPE_IP_ADDRESS= 'IP_ADDRESS'¶
-
ATTRIBUTE_TYPE_LONG= 'LONG'¶
-
ATTRIBUTE_TYPE_PASSWORD= 'PASSWORD'¶
-
ATTRIBUTE_TYPE_PORT= 'PORT'¶
-
ATTRIBUTE_TYPE_STRING= 'STRING'¶
- attribute_type (
-
class
com.vmware.nsx_policy.model_client.AttributeVal(data_type=None, key=None, multivalue=None, values=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains type specific properties of generic realized entity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - data_type (
strorNone) –Possible values are:
AttributeVal.DATA_TYPE_STRINGAttributeVal.DATA_TYPE_DATEAttributeVal.DATA_TYPE_INTEGERAttributeVal.DATA_TYPE_BOOLEAN
Datatype of the propertyThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- key (
strorNone) – Attribute key - multivalue (
boolorNone) – If attribute has a single value or collection of values This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - values (
listofstrorNone) – List of attribute values This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
DATA_TYPE_BOOLEAN= 'BOOLEAN'¶
-
DATA_TYPE_DATE= 'DATE'¶
-
DATA_TYPE_INTEGER= 'INTEGER'¶
-
DATA_TYPE_STRING= 'STRING'¶
- data_type (
-
class
com.vmware.nsx_policy.model_client.BFDDiagnosticCount(administratively_down_count=None, concatenated_path_down_count=None, control_detection_time_expired_count=None, echo_function_failed_count=None, forwarding_plane_reset_count=None, neighbor_signaled_session_down_count=None, no_diagnostic_count=None, path_down_count=None, reverse_concatenated_path_down_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - administratively_down_count (
longorNone) – Number of tunnels with administratively down diagnostic message format: int64 - concatenated_path_down_count (
longorNone) – Number of tunnels with concatenated path down diagnostic message format: int64 - control_detection_time_expired_count (
longorNone) – Number of tunnels with control detection time expired diagnostic message format: int64 - echo_function_failed_count (
longorNone) – Number of tunnels with echo function failed diagnostic message format: int64 - forwarding_plane_reset_count (
longorNone) – Number of tunnels with forwarding plane reset diagnostic message format: int64 - neighbor_signaled_session_down_count (
longorNone) – Number of tunnels neighbor signaled session down format: int64 - no_diagnostic_count (
longorNone) – Number of tunnels with no diagnostic format: int64 - path_down_count (
longorNone) – Number of tunnels with path down diagnostic message format: int64 - reverse_concatenated_path_down_count (
longorNone) – Number of tunnels with reverse concatenated path down diagnostic message format: int64
- administratively_down_count (
-
class
com.vmware.nsx_policy.model_client.BFDProperties(active=None, diagnostic=None, forwarding=None, remote_diagnostic=None, remote_state=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBFD information
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - active (
boolorNone) – True if tunnel is active in a gateway HA setup This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - diagnostic (
strorNone) – A short message indicating what the BFD session thinks is wrong in case of a problem This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - forwarding (
boolorNone) – True if the BFD session believes this interface may be used to forward traffic This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_diagnostic (
strorNone) – A short message indicating what the remote interface’s BFD session thinks is wrong in case of a problem This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_state (
strorNone) –Possible values are:
BFDProperties.REMOTE_STATE_UNKNOWN_STATEBFDProperties.REMOTE_STATE_ADMIN_DOWNBFDProperties.REMOTE_STATE_DOWNBFDProperties.REMOTE_STATE_INITBFDProperties.REMOTE_STATE_UP
State of the remote interface’s BFD sessionThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- state (
strorNone) –Possible values are:
BFDProperties.STATE_UNKNOWN_STATEBFDProperties.STATE_ADMIN_DOWNBFDProperties.STATE_DOWNBFDProperties.STATE_INITBFDProperties.STATE_UP
State of the BFD sessionThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
REMOTE_STATE_ADMIN_DOWN= 'ADMIN_DOWN'¶
-
REMOTE_STATE_DOWN= 'DOWN'¶
-
REMOTE_STATE_INIT= 'INIT'¶
-
REMOTE_STATE_UNKNOWN_STATE= 'UNKNOWN_STATE'¶
-
REMOTE_STATE_UP= 'UP'¶
-
STATE_ADMIN_DOWN= 'ADMIN_DOWN'¶
-
STATE_DOWN= 'DOWN'¶
-
STATE_INIT= 'INIT'¶
-
STATE_UNKNOWN_STATE= 'UNKNOWN_STATE'¶
-
STATE_UP= 'UP'¶
- active (
-
class
com.vmware.nsx_policy.model_client.BFDStatusCount(bfd_admin_down_count=None, bfd_down_count=None, bfd_init_count=None, bfd_up_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - bfd_admin_down_count (
longorNone) – Number of tunnels in BFD admin down state format: int32 - bfd_down_count (
longorNone) – Number of tunnels in BFD down state format: int32 - bfd_init_count (
longorNone) – Number of tunnels in BFD init state format: int32 - bfd_up_count (
longorNone) – Number of tunnels in BFD up state format: int32
- bfd_admin_down_count (
-
class
com.vmware.nsx_policy.model_client.BGPCommunityList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, communities=None, community_type=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - communities (
listofstr) – Array of BGP communities - community_type (
strorNone) –Possible values are:
Specifies the BGP community type. Currently, only NormalBGPCommunity is supported.
- logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMMUNITY_TYPE_NORMALBGPCOMMUNITY= 'NormalBGPCommunity'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BGPCommunityListListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBGPCommunityListorNone) – Paginated list of bgp community lists
- links (
-
class
com.vmware.nsx_policy.model_client.BackupConfiguration(backup_enabled=None, backup_schedule=None, inventory_summary_interval=None, passphrase=None, remote_file_server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructConfiguration for taking manual/automated backup
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - backup_enabled (
boolorNone) – true if automated backup is enabled - backup_schedule (
vmware.vapi.struct.VapiStructorNone) – Set when backups should be taken - on a weekly schedule or at regular intervals. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inBackupSchedule. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inBackupSchedule. - inventory_summary_interval (
longorNone) – The minimum number of seconds between each upload of the inventory summary to backup server. format: int64 - passphrase (
strorNone) – Passphrase used to encrypt backup files. - remote_file_server (
RemoteFileServer) – The server to which backups will be sent.
- backup_enabled (
-
class
com.vmware.nsx_policy.model_client.BackupOperationHistory(cluster_backup_statuses=None, inventory_backup_statuses=None, node_backup_statuses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPast backup operation details
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - cluster_backup_statuses (
listofBackupOperationStatusorNone) – Statuses of previous cluser backups - inventory_backup_statuses (
listofBackupOperationStatusorNone) – Statuses of previous inventory backups - node_backup_statuses (
listofBackupOperationStatusorNone) – Statuses of previous node backups
- cluster_backup_statuses (
-
class
com.vmware.nsx_policy.model_client.BackupOperationStatus(backup_id=None, end_time=None, error_code=None, error_message=None, start_time=None, success=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBackup operation status
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - backup_id (
str) – Unique identifier of a backup - end_time (
longorNone) – Time when operation was ended format: int64 - error_code (
strorNone) –Possible values are:
BackupOperationStatus.ERROR_CODE_NOT_RUN_ON_MASTERBackupOperationStatus.ERROR_CODE_SERVER_UNREACHABLEBackupOperationStatus.ERROR_CODE_AUTHENTICATION_FAILUREBackupOperationStatus.ERROR_CODE_PERMISSION_ERRORBackupOperationStatus.ERROR_CODE_TIMEOUTBackupOperationStatus.ERROR_CODE_BAD_FINGERPRINTBackupOperationStatus.ERROR_CODE_GENERIC_ERROR
Error code - error_message (
strorNone) – Error code details - start_time (
longorNone) – Time when operation was started format: int64 - success (
bool) – True if backup is successfully completed, else false
-
ERROR_CODE_AUTHENTICATION_FAILURE= 'BACKUP_AUTHENTICATION_FAILURE'¶
-
ERROR_CODE_BAD_FINGERPRINT= 'BACKUP_BAD_FINGERPRINT'¶
-
ERROR_CODE_GENERIC_ERROR= 'BACKUP_GENERIC_ERROR'¶
-
ERROR_CODE_NOT_RUN_ON_MASTER= 'BACKUP_NOT_RUN_ON_MASTER'¶
-
ERROR_CODE_PERMISSION_ERROR= 'BACKUP_PERMISSION_ERROR'¶
-
ERROR_CODE_SERVER_UNREACHABLE= 'BACKUP_SERVER_UNREACHABLE'¶
-
ERROR_CODE_TIMEOUT= 'BACKUP_TIMEOUT'¶
- backup_id (
-
class
com.vmware.nsx_policy.model_client.BackupSchedule(resource_type='BackupSchedule')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base type for Weekly or Interval Backup Schedule
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
BackupSchedule.RESOURCE_TYPE_WEEKLYBACKUPSCHEDULEBackupSchedule.RESOURCE_TYPE_INTERVALBACKUPSCHEDULE
Schedule type-
RESOURCE_TYPE_INTERVALBACKUPSCHEDULE= 'IntervalBackupSchedule'¶
-
RESOURCE_TYPE_WEEKLYBACKUPSCHEDULE= 'WeeklyBackupSchedule'¶
-
class
com.vmware.nsx_policy.model_client.BaseEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an endpoint which will be used as subject in redirection rule. It is a polymorphic type object which can be either of the types - 1. Virtual 2. Logical We have 2 separate objects representing these 2 types. VirtualEndPoint for Virtual type and ServiceInstanceEndpoint for Logical.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_ips (
listofIPInfo) – IPs where either inbound or outbound traffic is to be redirected.
-
RESOURCE_TYPE_SERVICEINSTANCEENDPOINT= 'ServiceInstanceEndpoint'¶
-
RESOURCE_TYPE_VIRTUALENDPOINT= 'VirtualEndpoint'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BaseEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of all endpoints under a tier-0
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – All endpoints under a tier-0 When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inBaseEndpoint. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inBaseEndpoint.
- links (
-
class
com.vmware.nsx_policy.model_client.BaseHostSwitchProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseHostSwitchProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
-
RESOURCE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE= 'ExtraConfigHostSwitchProfile'¶
-
RESOURCE_TYPE_LLDPHOSTSWITCHPROFILE= 'LldpHostSwitchProfile'¶
-
RESOURCE_TYPE_NIOCPROFILE= 'NiocProfile'¶
-
RESOURCE_TYPE_UPLINKHOSTSWITCHPROFILE= 'UplinkHostSwitchProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BaseNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_properties (
listofNodeInterfacePropertiesorNone) – Array of Node interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_statistics (
listofNodeInterfaceStatisticsPropertiesorNone) – Array of Node network interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_status (
ClusterNodeStatusorNone) – - node_status_properties (
listofNodeStatusPropertiesorNone) – Time series of the node’s system properties
- display_name (
-
class
com.vmware.nsx_policy.model_client.BasePolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an instance of partner Service and its configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - deployment_mode (
strorNone) –Possible values are:
BasePolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONEBasePolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
- partner_service_name (
str) – Unique name of Partner Service to be consumed in redirection - transport_type (
strorNone) –Possible values are:
BasePolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGEBasePolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTED
Transport to be used while deploying Service-VM.
-
DEPLOYMENT_MODE_ACTIVE_STANDBY= 'ACTIVE_STANDBY'¶
-
DEPLOYMENT_MODE_STAND_ALONE= 'STAND_ALONE'¶
-
TRANSPORT_TYPE_L2_BRIDGE= 'L2_BRIDGE'¶
-
TRANSPORT_TYPE_L3_ROUTED= 'L3_ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BasePolicyServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of all SI objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBasePolicyServiceInstance) – All service instance list results
- links (
-
class
com.vmware.nsx_policy.model_client.BaseServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe deployment of a registered service. service instance is instantiation of service.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
BaseServiceInstance.RESOURCE_TYPE_SERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_BYODSERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_VIRTUALSERVICEINSTANCE
ServiceInstance is used when NSX handles the lifecyle of appliance. Deployment and appliance related all the information is necessary. ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a custom instance to be used when NSX is not handling the lifecycle of an appliance and when the user is not bringing their own appliance.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - on_failure_policy (
strorNone) –Possible values are:
Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.
- service_id (
strorNone) – The Service to which the service instance is associated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_type (
str) –Possible values are:
Transport to be used by this service instance for deploying the Service-VM.
-
ON_FAILURE_POLICY_ALLOW= 'ALLOW'¶
-
ON_FAILURE_POLICY_BLOCK= 'BLOCK'¶
-
RESOURCE_TYPE_BYODSERVICEINSTANCE= 'ByodServiceInstance'¶
-
RESOURCE_TYPE_SERVICEINSTANCE= 'ServiceInstance'¶
-
RESOURCE_TYPE_VIRTUALSERVICEINSTANCE= 'VirtualServiceInstance'¶
-
TRANSPORT_TYPE_L2_BRIDGE= 'L2_BRIDGE'¶
-
TRANSPORT_TYPE_L3_ROUTED= 'L3_ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BaseSwitchingProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BaseSwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.BaseTier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTier-0 interface configuration for external connectivity.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofInterfaceSubnet) – Specify IP address and network prefix for interface.
- links (
-
class
com.vmware.nsx_policy.model_client.BaseTier0InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of all Interfaces
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBaseTier0Interface) – List of all Interface results including tier-0 interfaces and service interfaces.
- links (
-
class
com.vmware.nsx_policy.model_client.BatchRequest(continue_on_error=None, requests=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA set of operations to be performed in a single batch
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - continue_on_error (
boolorNone) – Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false. - requests (
listofBatchRequestItemorNone) –
- continue_on_error (
-
class
com.vmware.nsx_policy.model_client.BatchRequestItem(body=None, method=None, uri=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA single request within a batch of operations
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - body (
vmware.vapi.struct.VapiStructorNone) – - method (
str) –Possible values are:
BatchRequestItem.METHOD_GETBatchRequestItem.METHOD_POSTBatchRequestItem.METHOD_PUTBatchRequestItem.METHOD_DELETEBatchRequestItem.METHOD_PATCH
http method type - uri (
str) – relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters
-
METHOD_DELETE= 'DELETE'¶
-
METHOD_GET= 'GET'¶
-
METHOD_PATCH= 'PATCH'¶
-
METHOD_POST= 'POST'¶
-
METHOD_PUT= 'PUT'¶
- body (
-
class
com.vmware.nsx_policy.model_client.BatchResponse(has_errors=None, results=None, rolled_back=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe reponse to a batch operation
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - has_errors (
boolorNone) – Indicates if any of the APIs failed - results (
listofBatchResponseItem) – Bulk list results - rolled_back (
boolorNone) – Optional flag indicating that all items were rolled back even if succeeded initially
- has_errors (
-
class
com.vmware.nsx_policy.model_client.BatchResponseItem(body=None, code=None, headers=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA single respose in a list of batched responses
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - body (
vmware.vapi.struct.VapiStructorNone) – object returned by api - code (
long) – http status code format: int64 - headers (
vmware.vapi.struct.VapiStructorNone) – The headers returned by the API call
- body (
-
class
com.vmware.nsx_policy.model_client.BfdConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, declare_dead_multiple=None, enabled=None, logical_router_id=None, receive_interval=None, transmit_interval=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBFD configuration for LogicalRouter
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - declare_dead_multiple (
longorNone) – Number of times a packet is missed before BFD declares the neighbor down. format: int64 - enabled (
boolorNone) – Flag to enable BFD for this LogicalRouter - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - receive_interval (
longorNone) – the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats. format: int64 - transmit_interval (
longorNone) – the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats. format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.BfdConfigParameters(declare_dead_multiple=None, receive_interval=None, transmit_interval=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBFD configuration for the given Peer.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - declare_dead_multiple (
longorNone) – Number of times a packet is missed before BFD declares the neighbor down. format: int64 - receive_interval (
longorNone) – the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats. format: int64 - transmit_interval (
longorNone) – the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats. format: int64
- declare_dead_multiple (
-
class
com.vmware.nsx_policy.model_client.BfdHealthMonitoringProfile(enabled=None, probe_interval=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BfdHealthMonitoringProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProfile for BFD health monitoring
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – Whether the heartbeat is enabled. A POST or PUT request with "enabled" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value. - probe_interval (
longorNone) – The time interval (in millisec) between probe packets for tunnels between transport nodes. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- enabled (
-
class
com.vmware.nsx_policy.model_client.BgpConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, as_num=None, as_number=None, ecmp=None, enabled=None, graceful_restart=None, logical_router_id=None, route_aggregation=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - as_num (
strorNone) – 4 Byte ASN in ASPLAIN/ASDOT Format - as_number (
longorNone) – This is a deprecated property, Please use ‘as_num’ instead. format: int64 - ecmp (
boolorNone) – Flag to enable ECMP - enabled (
boolorNone) – Flag to enable this configuration - graceful_restart (
boolorNone) – Flag to enable graceful restart - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - route_aggregation (
listofBgpRouteAggregationorNone) – List of routes to be aggregated
- links (
-
class
com.vmware.nsx_policy.model_client.BgpNeighbor(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_families=None, bfd_config=None, enable_bfd=None, enabled=None, filter_in_ipprefixlist_id=None, filter_in_routemap_id=None, filter_out_ipprefixlist_id=None, filter_out_routemap_id=None, hold_down_timer=None, keep_alive_timer=None, logical_router_id=None, maximum_hop_limit=None, neighbor_address=None, password=None, remote_as=None, remote_as_num=None, source_address=None, source_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - address_families (
listofBgpNeighborAddressFamilyorNone) – User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration. - bfd_config (
BfdConfigParametersorNone) – By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer) - enable_bfd (
boolorNone) – Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence. - enabled (
boolorNone) – Flag to enable this BGP Neighbor - filter_in_ipprefixlist_id (
strorNone) – This is a deprecated property, Please use ‘address_family’ instead. - filter_in_routemap_id (
strorNone) – This is a deprecated property, Please use ‘address_family’ instead. - filter_out_ipprefixlist_id (
strorNone) – This is a deprecated property, Please use ‘address_family’ instead. - filter_out_routemap_id (
strorNone) – This is a deprecated property, Please use ‘address_family’ instead. - hold_down_timer (
longorNone) – Wait period (seconds) before declaring peer dead format: int64 - keep_alive_timer (
longorNone) – Frequency (seconds) with which keep alive messages are sent to peers format: int64 - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - maximum_hop_limit (
longorNone) – This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0. format: int32 - neighbor_address (
str) – Neighbor IP Address format: ipv4 - password (
strorNone) – User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 20 characters. - remote_as (
longorNone) – This is a deprecated property, Please use ‘remote_as_num’ instead. format: int64 - remote_as_num (
strorNone) – 4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format - source_address (
strorNone) – Deprecated - do not provide a value for this field. Use source_addresses instead. format: ipv4 - source_addresses (
listofstrorNone) – BGP neighborship will be formed from all these source addresses to this neighbour. format: ipv4
- links (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborAddressFamily(enabled=None, in_filter_ipprefixlist_id=None, in_filter_routemap_id=None, out_filter_ipprefixlist_id=None, out_filter_routemap_id=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
boolorNone) – Enable this address family - in_filter_ipprefixlist_id (
strorNone) – Id of the IPPrefix List to be used for IN direction filter - in_filter_routemap_id (
strorNone) – Id of the RouteMap to be used for IN direction filter - out_filter_ipprefixlist_id (
strorNone) – Id of the IPPrefixList to be used for OUT direction filter - out_filter_routemap_id (
strorNone) – Id of the RouteMap to be used for OUT direction filter - type (
str) –Possible values are:
Address family type
-
TYPE_IPV4_UNICAST= 'IPV4_UNICAST'¶
-
TYPE_VPNV4_UNICAST= 'VPNV4_UNICAST'¶
- enabled (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, in_route_filters=None, neighbor_address=None, out_route_filters=None, password=None, remote_as_num=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains information necessary to configure a BGP neighbor.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - in_route_filters (
listofstrorNone) – Specify paths of prefix-lists to filter routes for IN direction. - neighbor_address (
str) – Neighbor IP Address format: ip - out_route_filters (
listofstrorNone) – Specify paths of prefix-lists to filter routes for OUT direction. A built-in prefix-list named ‘prefixlist-out-default’ is automatically applied as first entry. - password (
strorNone) – Specify password for BGP neighbor authentication. Empty string ("") clears existing password. - remote_as_num (
str) – 4 Byte ASN of the neighbor in ASPLAIN Format
- links (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of BGP Neighbor Configs
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBgpNeighborConfig) – BGP neighbor configs list results
- links (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBgpNeighbor) – Paginated list of bgp neighbors
- links (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborStatus(announced_capabilities=None, connection_drop_count=None, connection_state=None, established_connection_count=None, graceful_restart=None, hold_time=None, keep_alive_interval=None, local_port=None, lr_component_id=None, messages_received=None, messages_sent=None, negotiated_capability=None, neighbor_address=None, neighbor_router_id=None, remote_as_number=None, remote_port=None, source_address=None, time_since_established=None, total_in_prefix_count=None, total_out_prefix_count=None, transport_node=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - announced_capabilities (
listofstrorNone) – BGP capabilities sent to BGP neighbor. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - connection_drop_count (
longorNone) – Count of connection drop format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - connection_state (
strorNone) –Possible values are:
BgpNeighborStatus.CONNECTION_STATE_INVALIDBgpNeighborStatus.CONNECTION_STATE_IDLEBgpNeighborStatus.CONNECTION_STATE_CONNECTBgpNeighborStatus.CONNECTION_STATE_ACTIVEBgpNeighborStatus.CONNECTION_STATE_OPEN_SENTBgpNeighborStatus.CONNECTION_STATE_OPEN_CONFIRMBgpNeighborStatus.CONNECTION_STATE_ESTABLISHED
Current state of the BGP session.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- established_connection_count (
longorNone) – Count of connections established format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - graceful_restart (
boolorNone) – Indicate current state of graceful restart where graceful_restart = true indicate graceful restart is enabled and graceful_restart = false indicate graceful restart is disabled. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - hold_time (
longorNone) – Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - keep_alive_interval (
longorNone) – Time in ms to wait for HELLO packet from BGP peer format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_port (
longorNone) – TCP port number of Local BGP connection format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lr_component_id (
strorNone) – Logical router component(Service Router/Distributed Router) id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - messages_received (
longorNone) – Count of messages received from the neighbor format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - messages_sent (
longorNone) – Count of messages sent to the neighbor format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - negotiated_capability (
listofstrorNone) – BGP capabilities negotiated with BGP neighbor. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - neighbor_address (
strorNone) – The IP of the BGP neighbor format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - neighbor_router_id (
strorNone) – Router ID of the BGP neighbor. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_as_number (
strorNone) – AS number of the BGP neighbor This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_port (
longorNone) – TCP port number of remote BGP Connection format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source_address (
strorNone) – The Ip address of logical port format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - time_since_established (
longorNone) – Time(in milliseconds) since connection was established. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total_in_prefix_count (
longorNone) – Count of in prefixes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total_out_prefix_count (
longorNone) – Count of out prefixes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node (
ResourceReferenceorNone) – Transport node id and name
-
CONNECTION_STATE_ACTIVE= 'ACTIVE'¶
-
CONNECTION_STATE_CONNECT= 'CONNECT'¶
-
CONNECTION_STATE_ESTABLISHED= 'ESTABLISHED'¶
-
CONNECTION_STATE_IDLE= 'IDLE'¶
-
CONNECTION_STATE_INVALID= 'INVALID'¶
-
CONNECTION_STATE_OPEN_CONFIRM= 'OPEN_CONFIRM'¶
-
CONNECTION_STATE_OPEN_SENT= 'OPEN_SENT'¶
- announced_capabilities (
-
class
com.vmware.nsx_policy.model_client.BgpNeighborsStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_id=None, logical_router_name=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated, unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_router_name (
strorNone) – Name of the logical router This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBgpNeighborStatusorNone) – Status of BGP neighbors of the logical router This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.BgpRouteAggregation(prefix=None, summary_only=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - prefix (
str) – cidr of the aggregate address format: ipv4-cidr-block - summary_only (
boolorNone) – Flag to send only summarized route
- prefix (
-
class
com.vmware.nsx_policy.model_client.BgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, local_as_num=None, route_aggregations=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains BGP routing configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_as_num (
str) – Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., "65546") or ASDOT (e.g., "1.10") format. Empty string disables BGP feature. - route_aggregations (
listofRouteAggregationEntryorNone) – List of routes to be aggregated.
- links (
-
class
com.vmware.nsx_policy.model_client.BpduFilter(enabled=None, white_list=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBPDU filter configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – Indicates whether BPDU filter is enabled - white_list (
listofstrorNone) – Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering
- enabled (
-
class
com.vmware.nsx_policy.model_client.BridgeCluster(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_nodes=None, cluster_profile_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge Cluster
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bridge_nodes (
listofBridgeClusterNode) – Nodes used in bridging - cluster_profile_bindings (
listofClusterProfileTypeIdEntryorNone) – Bridge cluster profile bindings
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeClusterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge cluster queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBridgeClusterorNone) – BridgeCluster Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeClusterNode(ha_mac=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge transport node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ha_mac (
strorNone) – MAC address used for HA protocol This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
str) – UUID of the transport node
- ha_mac (
-
class
com.vmware.nsx_policy.model_client.BridgeEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bridge_cluster_id=None, bridge_endpoint_profile_id=None, ha_enable=None, vlan=None, vlan_transport_zone_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA bridge endpoint can be created on a bridge cluster or on an edge cluster. Few of the properties of this class will not be used depending on the type of bridge endpoint being created. When creating a bridge endpoint on a bridge cluster, following propeties will be used: vlan, bridge_cluster_id and ha_enable. Similarly, for creating a bridge endpoint on an edge cluster following properties will be used: vlan, bridge_endpoint_profile_id and vlan_transport_zone_id.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bridge_cluster_id (
strorNone) – This field will not be used if an edge cluster is being used for the bridge endpoint - bridge_endpoint_profile_id (
strorNone) – This field will not be used if a bridge cluster is being used for the bridge endpoint - ha_enable (
boolorNone) – This field will not be used if an edge cluster is being used for the bridge endpoint - vlan (
long) – Virtual Local Area Network Identifier format: int64 - vlan_transport_zone_id (
strorNone) – This field will not be used if a bridge cluster is being used for the bridge endpoint
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge Endpoint queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBridgeEndpointorNone) – BridgeEndpoint Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeEndpointProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, edge_cluster_id=None, edge_cluster_member_indexes=None, failover_mode=None, high_availability_mode=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge Endpoint Profile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - edge_cluster_id (
str) – UUID of the edge cluster for this bridge endpoint - edge_cluster_member_indexes (
listoflongorNone) – First index will be used as the preferred member format: int32 - failover_mode (
strorNone) –Possible values are:
Faileover mode can be preemmptive or non-preemptive - high_availability_mode (
strorNone) –Possible values are:
High avaialability mode can be active-active or active-standby
-
FAILOVER_MODE_NON_PREEMPTIVE= 'NON_PREEMPTIVE'¶
-
FAILOVER_MODE_PREEMPTIVE= 'PREEMPTIVE'¶
-
HIGH_AVAILABILITY_MODE_STANDBY= 'ACTIVE_STANDBY'¶
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeEndpointProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBridge Endpoint Profile queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofBridgeEndpointProfileorNone) – BridgeEndpointProfile Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.BridgeHighAvailabilityClusterProfile(bfd_probe_interval=None, enable=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='BridgeHighAvailabilityClusterProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProfile for BFD HA cluster setting
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bfd_probe_interval (
longorNone) – the time interval (in millisec) between probe packets for heartbeat purpose format: int64 - enable (
boolorNone) – whether the heartbeat is enabled - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
ClusterProfile.RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILESupported cluster profiles.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- bfd_probe_interval (
-
class
com.vmware.nsx_policy.model_client.ByodPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an instance of partner’s service whose wiring will be done by partner itself. As partner does all the wiring, we call it as Byod - Bring your own device.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - deployment_mode (
strorNone) –Possible values are:
ByodPolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONEByodPolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
- partner_service_name (
str) – Unique name of Partner Service to be consumed in redirection - transport_type (
strorNone) –Possible values are:
ByodPolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGEByodPolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTED
Transport to be used while deploying Service-VM.
-
DEPLOYMENT_MODE_ACTIVE_STANDBY= 'ACTIVE_STANDBY'¶
-
DEPLOYMENT_MODE_STAND_ALONE= 'STAND_ALONE'¶
-
TRANSPORT_TYPE_L2_BRIDGE= 'L2_BRIDGE'¶
-
TRANSPORT_TYPE_L3_ROUTED= 'L3_ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ByodPolicyServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of only Byod SI objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofByodPolicyServiceInstance) – Byod Service instance list results
- links (
-
class
com.vmware.nsx_policy.model_client.ByodServiceInstance(deployment_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ByodServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - deployment_mode (
str) –Possible values are:
Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
BaseServiceInstance.RESOURCE_TYPE_SERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_BYODSERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_VIRTUALSERVICEINSTANCE
ServiceInstance is used when NSX handles the lifecyle of appliance. Deployment and appliance related all the information is necessary. ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a custom instance to be used when NSX is not handling the lifecycle of an appliance and when the user is not bringing their own appliance.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - on_failure_policy (
strorNone) –Possible values are:
Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.
- service_id (
strorNone) – The Service to which the service instance is associated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_type (
str) –Possible values are:
Transport to be used by this service instance for deploying the Service-VM.
-
DEPLOYMENT_MODE_ACTIVE_STANDBY= 'ACTIVE_STANDBY'¶
-
DEPLOYMENT_MODE_STAND_ALONE= 'STAND_ALONE'¶
- deployment_mode (
-
class
com.vmware.nsx_policy.model_client.CapacityUsage(links=None, schema=None, self_=None, capacity_type=None, usage_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructusage of each capacity type ex. vm, cpu
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - capacity_type (
strorNone) – type of the capacity field This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - usage_count (
longorNone) – count of number of items of capacity_type format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.Certificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, details=None, pem_encoded=None, used_by=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - details (
listofX509CertificateorNone) – list of X509Certificates This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - pem_encoded (
str) – pem encoded certificate data - used_by (
listofNodeIdServicesMaporNone) – list of node IDs with services, that are using this certificate This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.CertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCertificate queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCertificateorNone) – Certificate list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildBgpNeighborConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_routing_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for BgpNeighborConfig, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bgp_routing_config (
BgpNeighborConfig) – Contains the actual BgpNeighborConfig object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildBgpRoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_routing_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for BgpRoutingConfig, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bgp_routing_config (
BgpRoutingConfig) – Contains the actual BgpRoutingConfig object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildByodPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, byod_policy_service_instance=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for ByodPolicyServiceInstance used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - byod_policy_service_instance (
ByodPolicyServiceInstance) – Contains actual ByodPolicyServiceInstance.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildCommunicationEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, communication_entry=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for CommunicationEntry, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - communication_entry (
CommunicationEntry) – Contains the actual CommunicationEntry object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildCommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, communication_map=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for CommunicationMap, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - communication_map (
CommunicationMap) – Contains the actual CommunicationMap object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildConstraint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, constraint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Constraint, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - constraint (
Constraint) – Contains the actual Constraint object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildDeploymentZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, deployment_zone=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for DeploymentZone, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - deployment_zone (
DeploymentZone) – Contains the actual DeploymentZone object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildDomain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, domain=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for domain, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - domain (
Domain) – Contains the actual domain object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildDomainDeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, domain_deployment_map=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for DomainDeploymentMap, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - domain_deployment_map (
DomainDeploymentMap) – Contains the actual DomainDeploymentMap object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildEnforcementPoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enforcement_point=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for EnforcementPoint, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enforcement_point (
EnforcementPoint) – Contains the actual Enforcement point object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildGatewayPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_policy=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for GatewayPolicy, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - gateway_policy (
GatewayPolicy) – Contains the actual GatewayPolicy object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, group=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for group, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - group (
Group) – Contains the actual group objects
- links (
-
class
com.vmware.nsx_policy.model_client.ChildL2Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l2_vpn=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for L2Vpn, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - l2_vpn (
L2Vpn) – Contains the actual L2Vpn object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildL2VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l2_vpn_context=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for L2VpnContext, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - l2_vpn_context (
L2VpnContext) – Contains the actual L2VpnContext object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildL3Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l3_vpn=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for L3Vpn, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - l3_vpn (
L3Vpn) – Contains the actual L3Vpn object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildL3VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, l3_vpn_context=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for L3VpnContext, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - l3_vpn_context (
L3VpnContext) – Contains the actual L3VpnContext object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_app_profile=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBAppProfile, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_app_profile (
vmware.vapi.struct.VapiStruct) – Contains the actual LBAppProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBAppProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBAppProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_client_ssl_profile=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBClientSslProfile, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_client_ssl_profile (
LBClientSslProfile) – Contains the actual LBClientSslProfile object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_monitor_profile=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBMonitorProfile, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_monitor_profile (
vmware.vapi.struct.VapiStruct) – Contains the actual LBMonitorProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBMonitorProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBMonitorProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_persistence_profile=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBPersistenceProfile, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_persistence_profile (
vmware.vapi.struct.VapiStruct) – Contains the actual LBPersistenceProfile object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBPersistenceProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBPersistenceProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_pool=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBPool, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_pool (
LBPool) – Contains the actual LBPool object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_server_ssl_profile=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBServerSslProfile, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_server_ssl_profile (
LBServerSslProfile) – Contains the actual LBServerSslProfile object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBService, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_service (
LBService) – Contains the actual LBService object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLBVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, lb_virtual_server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for LBVirtualServer, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - lb_virtual_server (
LBVirtualServer) – Contains the actual LBVirtualServer object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildLocaleServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, locale_services=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for LocaleServices, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - locale_services (
LocaleServices) – Contains the actual LocaleServices object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyConfigResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an object on the desired state
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyDnsForwarder(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_dns_forwarder=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyDnsForwarder, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_dns_forwarder (
PolicyDnsForwarder) – Contains the actual PolicyDnsForwarder object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyDnsForwarderZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_dns_forwarder_zone=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyDnsForwarderZone, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_dns_forwarder_zone (
PolicyDnsForwarderZone) – Contains the actual PolicyDnsForwarderZone object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyLabel(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyLabel, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_label (
PolicyLabel) – Contains the actual PolicyLabel object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyNat(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_nat=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyNat, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_nat (
PolicyNat) – Contains the actual PolicyNAT object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyNatRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_nat_rule=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyNatRule, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_nat_rule (
PolicyNatRule) – Contains the actual PolicyNatRule object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, policy_service_instance=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PolicyServiceInstance used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - policy_service_instance (
PolicyServiceInstance) – Contains actual PolicyServiceInstance.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildPrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, prefix_list=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for PrefixList, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - prefix_list (
PrefixList) – Contains the actual PrefixList object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildRedirectionPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_policy=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for RedirectionPolicy used in Hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - redirection_policy (
RedirectionPolicy) – Contains actual RedirectionPolicy.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildRedirectionRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, redirection_rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for ChildRedirectionRule used in Hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - redirection_rules (
RedirectionRule) – Contains actual RedirectionRule.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Rule, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - rule (
Rule) – Contains the actual Rule object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildSecurityPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, security_policy=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for SecurityPolicy, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - security_policy (
SecurityPolicy) – Contains the actual SecurityPolicy object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildSegment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, segment=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Segment, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - segment (
Segment) – Contains the actual Segment object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Service, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - service (
Service) – Contains the actual Service object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildServiceEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for ServiceEntry, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - service (
vmware.vapi.struct.VapiStruct) – Contains the actual ServiceEntry object When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inServiceEntry.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildServiceInstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service_instance_endpoint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for ServiceInstanceEndpoint used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - service_instance_endpoint (
ServiceInstanceEndpoint) – Contains actual ServiceInstanceEndpoint.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildServiceInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, service_interface=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for ServiceInterface, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - service_interface (
ServiceInterface) – Contains the actual ServiceInterface object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildStaticARPConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, static_arp_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for StaticARPConfig, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - static_arp_config (
StaticARPConfig) – Contains the actual StaticARPConfig object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildStaticRoutes(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, static_routes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for StaticRoutes, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - static_routes (
StaticRoutes) – Contains the actual StaticRoutes object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTier0(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Tier-0, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tier0 (
Tier0) – Contains the actual Tier-0 object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTier0DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0_deployment_map=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Tier0DeploymentMap, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tier0_deployment_map (
Tier0DeploymentMap) – Contains the actual Tier0DeploymentMap object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier0_interface=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Tier0Interface, used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tier0_interface (
Tier0Interface) – Contains the actual Tier0Interface object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTier1(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tier1=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for Tier-1 , used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tier1 (
Tier1) – Contains the actual Tier-1 object.
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTlsCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tls_certificate=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for TlsCertificate, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tls_certificate (
TlsCertificate) – Contains the actual TlsCertificate object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildTlsTrustData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, tls_trust_data=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper for TlsTrustData, used in hierarchical API
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - tls_trust_data (
TlsTrustData) – Contains the actual TlsTrustData object
- links (
-
class
com.vmware.nsx_policy.model_client.ChildVirtualEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, virtual_endpoint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructChild wrapper object for VirtualEndpoint used in hierarchical API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - virtual_endpoint (
VirtualEndpoint) – Contains reference to actual VirtualEndpoint.
- links (
-
class
com.vmware.nsx_policy.model_client.ClasslessStaticRoute(network=None, next_hop=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - network (
str) – destination in cidr format: address-or-block-or-range - next_hop (
str) – router format: ip
- network (
-
class
com.vmware.nsx_policy.model_client.ClientSslProfileBinding(certificate_chain_depth=None, client_auth=None, client_auth_ca_ids=None, client_auth_crl_ids=None, default_certificate_id=None, sni_certificate_ids=None, ssl_profile_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - certificate_chain_depth (
longorNone) – authentication depth is used to set the verification depth in the client certificates chain. format: int64 - client_auth (
strorNone) –Possible values are:
client authentication mode - client_auth_ca_ids (
listofstrorNone) – If client auth type is REQUIRED, client certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. - client_auth_crl_ids (
listofstrorNone) – A Certificate Revocation List (CRL) can be specified in the client-side SSL profile binding to disallow compromised client certificates. - default_certificate_id (
str) – A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension. - sni_certificate_ids (
listofstrorNone) – Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. - ssl_profile_id (
strorNone) – Client SSL profile defines reusable, application-independent client side SSL properties.
-
CLIENT_AUTH_IGNORE= 'IGNORE'¶
-
CLIENT_AUTH_REQUIRED= 'REQUIRED'¶
- certificate_chain_depth (
-
class
com.vmware.nsx_policy.model_client.ClientTypeCollectionConfiguration(client_type=None, data_type_configurations=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHPM client data collection configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - client_type (
str) –Possible values are:
ClientTypeCollectionConfiguration.CLIENT_TYPE_HYPERVISORClientTypeCollectionConfiguration.CLIENT_TYPE_EDGEClientTypeCollectionConfiguration.CLIENT_TYPE_CONTROL_PLANEClientTypeCollectionConfiguration.CLIENT_TYPE_CONTROL_PLANE_PLATFORMClientTypeCollectionConfiguration.CLIENT_TYPE_MANAGEMENT_PLANEClientTypeCollectionConfiguration.CLIENT_TYPE_MANAGEMENT_PLANE_PLATFORM
The client type for which this data collection frequency setting applies
- data_type_configurations (
listofDataTypeCollectionConfiguration) – The set of data collection type configurations, one for each data collection type
-
CLIENT_TYPE_CONTROL_PLANE= 'CONTROL_PLANE'¶
-
CLIENT_TYPE_CONTROL_PLANE_PLATFORM= 'CONTROL_PLANE_PLATFORM'¶
-
CLIENT_TYPE_EDGE= 'EDGE'¶
-
CLIENT_TYPE_HYPERVISOR= 'HYPERVISOR'¶
-
CLIENT_TYPE_MANAGEMENT_PLANE= 'MANAGEMENT_PLANE'¶
-
CLIENT_TYPE_MANAGEMENT_PLANE_PLATFORM= 'MANAGEMENT_PLANE_PLATFORM'¶
- client_type (
-
class
com.vmware.nsx_policy.model_client.ClusterBackupInfo(ip_address=None, node_id=None, timestamp=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCluster backup details
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_address (
strorNone) – IP address of the node from which the backup was taken format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_id (
strorNone) – ID of the node from which the backup was taken This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – timestamp of the cluster backup file format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ip_address (
-
class
com.vmware.nsx_policy.model_client.ClusterBackupInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofClusterBackupInfoorNone) – List of timestamps of backed-up cluster files This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterConfig(links=None, schema=None, self_=None, revision=None, cluster_id=None, control_cluster_changes_allowed=None, mgmt_cluster_changes_allowed=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - cluster_id (
strorNone) – Unique identifier of this cluster This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - control_cluster_changes_allowed (
bool) – True if control cluster nodes may be added or removed - mgmt_cluster_changes_allowed (
bool) – True if management cluster nodes may be added or removed
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterGroupMemberStatus(member_name=None, member_status=None, member_uuid=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis type contains the attributes and status of a group member.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - member_name (
strorNone) – Name of the group member format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - member_status (
strorNone) –Possible values are:
ClusterGroupMemberStatus.MEMBER_STATUS_UPClusterGroupMemberStatus.MEMBER_STATUS_DOWNClusterGroupMemberStatus.MEMBER_STATUS_UNKNOWN
Status of the group memberThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- member_uuid (
strorNone) – UUID of the group member This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MEMBER_STATUS_DOWN= 'DOWN'¶
-
MEMBER_STATUS_UNKNOWN= 'UNKNOWN'¶
-
MEMBER_STATUS_UP= 'UP'¶
- member_name (
-
class
com.vmware.nsx_policy.model_client.ClusterGroupServiceLeader(leader_uuid=None, lease_version=None, service_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEach cluster node entity provides multiple services. When working in a group, each service can elect a cluster node entity to be the leader of the service. Leader election helps in coordination of the service. The leader holds a renewable lease on the leadership for a fixed period of time. The lease version is incremented every time the leadership lease is renewed. This type contains the attributes of a leader.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - leader_uuid (
strorNone) – Member UUID of the leader This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lease_version (
longorNone) – Number of times the lease has been renewed format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_name (
strorNone) – Name of the service This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- leader_uuid (
-
class
com.vmware.nsx_policy.model_client.ClusterGroupStatus(group_id=None, group_status=None, group_type=None, leaders=None, members=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis type contains the attributes and status of a group.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - group_id (
strorNone) – UUID of the group This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - group_status (
strorNone) –Possible values are:
ClusterGroupStatus.GROUP_STATUS_STABLEClusterGroupStatus.GROUP_STATUS_DEGRADEDClusterGroupStatus.GROUP_STATUS_UNSTABLEClusterGroupStatus.GROUP_STATUS_UNAVAILABLE
Group statusThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- group_type (
strorNone) –Possible values are:
ClusterGroupStatus.GROUP_TYPE_MANAGERClusterGroupStatus.GROUP_TYPE_CONTROLLERClusterGroupStatus.GROUP_TYPE_POLICYClusterGroupStatus.GROUP_TYPE_HTTP
Type of the groupThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- leaders (
listofClusterGroupServiceLeaderorNone) – Array of group leaders and their attributes This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - members (
listofClusterGroupMemberStatusorNone) – Array of group members and their statuses This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
GROUP_STATUS_DEGRADED= 'DEGRADED'¶
-
GROUP_STATUS_STABLE= 'STABLE'¶
-
GROUP_STATUS_UNAVAILABLE= 'UNAVAILABLE'¶
-
GROUP_STATUS_UNSTABLE= 'UNSTABLE'¶
-
GROUP_TYPE_CONTROLLER= 'CONTROLLER'¶
-
GROUP_TYPE_HTTP= 'HTTP'¶
-
GROUP_TYPE_MANAGER= 'MANAGER'¶
-
GROUP_TYPE_POLICY= 'POLICY'¶
- group_id (
-
class
com.vmware.nsx_policy.model_client.ClusterInitializationNodeInfo(disk_store_id=None, host_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe type provides the information of a non-running cluster node required for the initialization of a management cluster. The administrator needs to start this node for management cluster to initialize properly (or decommission it explicitly).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - disk_store_id (
strorNone) – The (internal) disk-store ID of the member This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_address (
strorNone) – The IP address (or domain name) of the cluster node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- disk_store_id (
-
class
com.vmware.nsx_policy.model_client.ClusterNodeConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, appliance_mgmt_listen_addr=None, controller_role=None, external_id=None, manager_role=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - appliance_mgmt_listen_addr (
strorNone) – The IP and port for the appliance management API service on this node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - controller_role (
ControllerClusterRoleConfigorNone) – - external_id (
strorNone) – Internal identifier provided by the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - manager_role (
ManagementClusterRoleConfigorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterNodeConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofClusterNodeConfig) – Cluster node configuration results
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterNodeStatus(control_cluster_status=None, mgmt_cluster_status=None, system_status=None, version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - control_cluster_status (
ControlClusterNodeStatusorNone) – Clustering status for control plane functions on this node - mgmt_cluster_status (
ManagementClusterNodeStatusorNone) – Clustering status for management plane functions on this node - system_status (
NodeStatusPropertiesorNone) – Node status properties - version (
strorNone) – Software version running on node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- control_cluster_status (
-
class
com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentConfig(placement_type='ClusterNodeVMDeploymentConfig')¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains info used to configure the VM on deployment
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: placement_type ( str) –Possible values are:
Specifies the config for the platform through which to deploy the VM
-
PLACEMENT_TYPE_VSPHERECLUSTERNODEVMDEPLOYMENTCONFIG= 'VsphereClusterNodeVMDeploymentConfig'¶
-
-
class
com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequest(deployment_config=None, form_factor=None, roles=None, user_settings=None, vm_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains the deployment information for a cluster node VM soon to be deployed or already deployed by the Manager
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - deployment_config (
vmware.vapi.struct.VapiStruct) – Info needed to configure a cluster node VM at deployment for a specific platform. May require different parameters depending on the method used to deploy the VM. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inClusterNodeVMDeploymentConfig. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inClusterNodeVMDeploymentConfig. - form_factor (
strorNone) –Possible values are:
ClusterNodeVMDeploymentRequest.FORM_FACTOR_SMALLClusterNodeVMDeploymentRequest.FORM_FACTOR_MEDIUMClusterNodeVMDeploymentRequest.FORM_FACTOR_MEDIUM_LARGEClusterNodeVMDeploymentRequest.FORM_FACTOR_LARGE
Specifies the desired "size" of the VM Note: MEDIUM is currently the only supported size for controllers.
- roles (
listofstr) –Possible values are:
List of cluster node role (or roles) which the VM should take on. They specify what type (or types) of cluster node which the new VM should act as.
- user_settings (
NodeUserSettingsorNone) – Username and password settings for the cluster node VM. Note: These settings will be honored only during VM deployment. Post-deployment, CLI must be used for changing the user settings and changes to these parameters will not have any effect. - vm_id (
strorNone) – ID of the VM maintained internally and used to recognize it. Note: This is automatically generated and cannot be modified. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
FORM_FACTOR_LARGE= 'LARGE'¶
-
FORM_FACTOR_MEDIUM= 'MEDIUM'¶
-
FORM_FACTOR_MEDIUM_LARGE= 'MEDIUM_LARGE'¶
-
FORM_FACTOR_SMALL= 'SMALL'¶
-
ROLES_CONTROLLER= 'CONTROLLER'¶
-
ROLES_MANAGER= 'MANAGER'¶
- deployment_config (
-
class
com.vmware.nsx_policy.model_client.ClusterNodeVMDeploymentRequestList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of ClusterNodeVMDeploymentRequests
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofClusterNodeVMDeploymentRequest) – Array of existing ClusterNodeVMDeploymentRequests
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ClusterProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
ClusterProfile.RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILESupported cluster profiles.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE= 'BridgeHighAvailabilityClusterProfile'¶
-
RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE= 'EdgeHighAvailabilityProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCluster Profile queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – Cluster Profile Results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inClusterProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inClusterProfile. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ClusterProfileTypeIdEntry(profile_id=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - profile_id (
str) – key value - resource_type (
strorNone) –Possible values are:
ClusterProfileTypeIdEntry.RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILESupported cluster profiles.
-
RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE= 'BridgeHighAvailabilityClusterProfile'¶
-
RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE= 'EdgeHighAvailabilityProfile'¶
- profile_id (
-
class
com.vmware.nsx_policy.model_client.ClusterRestoreStatus(backup_timestamp=None, endpoints=None, id=None, instructions=None, restore_end_time=None, restore_start_time=None, status=None, step=None, total_steps=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCluster restore status
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - backup_timestamp (
longorNone) – Timestamp when backup was initiated in epoch millisecond format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - endpoints (
listofResourceLinkorNone) – The list of allowed endpoints, based on the current state of the restore process This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - id (
strorNone) – Unique id for backup request This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - instructions (
listofInstructionInfoorNone) – Instructions for users to reconcile Restore operations This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - restore_end_time (
longorNone) – Timestamp when restore was completed in epoch millisecond format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - restore_start_time (
longorNone) – Timestamp when restore was started in epoch millisecond format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
GlobalRestoreStatusorNone) – - step (
RestoreSteporNone) – - total_steps (
longorNone) – Total number of steps in the entire restore process format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- backup_timestamp (
-
class
com.vmware.nsx_policy.model_client.ClusterRoleConfig(type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( strorNone) –Possible values are:
ClusterRoleConfig.TYPE_MANAGEMENTCLUSTERROLECONFIGClusterRoleConfig.TYPE_CONTROLLERCLUSTERROLECONFIG
Type of this role configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
TYPE_CONTROLLERCLUSTERROLECONFIG= 'ControllerClusterRoleConfig'¶
-
TYPE_MANAGEMENTCLUSTERROLECONFIG= 'ManagementClusterRoleConfig'¶
-
class
com.vmware.nsx_policy.model_client.ClusterStatus(cluster_id=None, control_cluster_status=None, mgmt_cluster_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cluster_id (
strorNone) – Unique identifier of this cluster This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - control_cluster_status (
ControllerClusterStatusorNone) – The current status of the control cluster - mgmt_cluster_status (
ManagementClusterStatusorNone) – The current status of the management cluster
- cluster_id (
-
class
com.vmware.nsx_policy.model_client.ClusteringInfo(join_to_existing_cluster=None, shared_secret=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructClustering parameters for the controller cluster
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - join_to_existing_cluster (
bool) – Property to indicate if the node must join an existing cluster. - shared_secret (
strorNone) – Shared secret of the cluster.
- join_to_existing_cluster (
-
class
com.vmware.nsx_policy.model_client.ClustersAggregateInfo(cluster_status=None, controller_cluster=None, management_cluster=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cluster_status (
AllClusterGroupStatus) – Status of all the cluster groups - controller_cluster (
listofControllerNodeAggregateInfo) – Array of Controller Nodes - management_cluster (
listofManagementNodeAggregateInfo) – Array of Management Nodes
- cluster_status (
-
class
com.vmware.nsx_policy.model_client.ColumnItem(column_identifier=None, drilldown_id=None, field=None, hidden=None, label=None, navigation=None, render_configuration=None, sort_ascending=None, sort_key=None, tooltip=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a column of the Grid
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - column_identifier (
strorNone) – Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column’s data will not participate in searches and drilldowns. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. - field (
str) – Field from which values of the column will be derived. - hidden (
boolorNone) – If set to true, hides the column - label (
Label) – Label of the column. - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used. - render_configuration (
listofRenderConfigurationorNone) – Render configuration to be applied, if any. - sort_ascending (
boolorNone) – If true, the value of the column are sorted in ascending order. Otherwise, in descending order. - sort_key (
strorNone) – Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested. - tooltip (
listofTooltiporNone) – Multi-line text to be shown on tooltip while hovering over a cell in the grid. - type (
str) –Possible values are:
Data type of the field.
-
TYPE_DATE= 'Date'¶
-
TYPE_NUMBER= 'Number'¶
-
TYPE_STRING= 'String'¶
- column_identifier (
-
class
com.vmware.nsx_policy.model_client.CommunicationEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA communication entry indicates the action to be performed for various types of traffic flowing between workload groups.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - action (
strorNone) –Possible values are:
The action to be applied to all the services - destination_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - scope (
listofstrorNone) – The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs. - sequence_number (
longorNone) – This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain format: int32 - services (
listofstrorNone) – In order to specify all services, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values. - source_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REJECT= 'REJECT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.CommunicationEntryListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of CommunicationEntries
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCommunicationEntry) – CommunicationEntry list results
- links (
-
class
com.vmware.nsx_policy.model_client.CommunicationInsertParameters(anchor_path=None, operation=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructParameters to let the admin specify a relative position of a communication map or communication entry w.r.t to another one.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - anchor_path (
strorNone) – The communication map/communication entry path if operation is ‘insert_after’ or ‘insert_before’ - operation (
strorNone) –Possible values are:
CommunicationInsertParameters.OPERATION_TOPCommunicationInsertParameters.OPERATION_BOTTOMCommunicationInsertParameters.OPERATION_AFTERCommunicationInsertParameters.OPERATION_BEFORE
Operation
-
OPERATION_AFTER= 'insert_after'¶
-
OPERATION_BEFORE= 'insert_before'¶
-
OPERATION_BOTTOM= 'insert_bottom'¶
-
OPERATION_TOP= 'insert_top'¶
- anchor_path (
-
class
com.vmware.nsx_policy.model_client.CommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, communication_entries=None, precedence=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of CommunicationEntries. This object is created by default along with the Domain.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - category (
strorNone) – Policy framework provides four pre-defined categories for classifying a communication map. They are "Emergency", "Infrastructure" "Environmental" and "Application". There is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environmental and then Application rules. Administrator can choose to categorize a communication map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - communication_entries (
listofCommunicationEntryorNone) – CommunicationEntries that are a part of this CommunicationMap - precedence (
longorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.CommunicationMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Communication map
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCommunicationMap) – CommunicationMap list results
- links (
-
class
com.vmware.nsx_policy.model_client.CommunityMatchExpression(expression=None, operator=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCommunity match expression
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - expression (
listofCommunityMatchOperation) – Array of community match operations - operator (
strorNone) –Possible values are:
Operator for evaluating community match expressions. AND logical AND operator This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
OPERATOR_AND= 'AND'¶
- expression (
-
class
com.vmware.nsx_policy.model_client.CommunityMatchOperation(community_list_id=None, match_operator=None, regular_expression=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCommunity match operation
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - community_list_id (
strorNone) – ID of BGP community list. This value is not required when match_operator is MATCH_REGEX otherwise required. - match_operator (
strorNone) –Possible values are:
CommunityMatchOperation.MATCH_OPERATOR_ANYCommunityMatchOperation.MATCH_OPERATOR_ALLCommunityMatchOperation.MATCH_OPERATOR_EXACTCommunityMatchOperation.MATCH_OPERATOR_NONECommunityMatchOperation.MATCH_OPERATOR_REGEX
Match operator for communities from provided community list id. MATCH_ANY will match any community MATCH_ALL will match all communities MATCH_EXACT will do exact match on community MATCH_NONE will not match any community MATCH_REGEX will match community by evaluating regular expression
- regular_expression (
strorNone) – Regular expression to match BGP communities. If match_operator is MATCH_REGEX then this value must be specified.
-
MATCH_OPERATOR_ALL= 'MATCH_ALL'¶
-
MATCH_OPERATOR_ANY= 'MATCH_ANY'¶
-
MATCH_OPERATOR_EXACT= 'MATCH_EXACT'¶
-
MATCH_OPERATOR_NONE= 'MATCH_NONE'¶
-
MATCH_OPERATOR_REGEX= 'MATCH_REGEX'¶
- community_list_id (
-
class
com.vmware.nsx_policy.model_client.ComputeCollection(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, cm_local_id=None, external_id=None, origin_id=None, origin_properties=None, origin_type=None, owner_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - last_sync_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cm_local_id (
strorNone) – Local Id of the compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – External ID of the ComputeCollection in the source Compute manager, e.g. mo-ref in VC This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_id (
strorNone) – Id of the compute manager from where this Compute Collection was discovered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_properties (
listofKeyValuePairorNone) – Key-Value map of additional specific properties of compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_type (
strorNone) – ComputeCollection type like VC_Cluster. Here the Compute Manager type prefix would help in differentiating similar named Compute Collection types from different Compute Managers This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - owner_id (
strorNone) – Id of the owner of compute collection in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionFabricTemplate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, auto_install_nsx=None, compute_collection_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCompute collection fabric template
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - auto_install_nsx (
bool) – Indicates whether NSX components should be automcatically installed. When ‘true’ NSX components will be automatically installed on the new host added to compute collection. - compute_collection_id (
str) – Associated compute collection id
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionFabricTemplateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of compute collection fabric template
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofComputeCollectionFabricTemplateorNone) – List of compute collection fabric template This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCompute Collection list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofComputeCollection) – Compute Collection list results
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionNetworkInterfacesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of network interfaces for all discovered nodes in compute collection
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDiscoveredNodeNetworkInterfaces) – List of discovered node with network interfaces
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionTransportNodeTemplate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, compute_collection_ids=None, host_switch_spec=None, network_migration_spec_ids=None, transport_zone_endpoints=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCompute collection transport node template
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - compute_collection_ids (
listofstr) – Associated compute collection ids - host_switch_spec (
vmware.vapi.struct.VapiStructorNone) – Property ‘host_switch_spec’ can be used to create either standard host switch or preconfigured host switch. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inHostSwitchSpec. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inHostSwitchSpec. - network_migration_spec_ids (
listofNetworkMigrationSpecTypeIdEntryorNone) – Property ‘network_migration_spec_ids’ should only be used for compute collections which are clusters in VMware vCenter. Currently only HostProfileNetworkMigrationSpec type is supported. This specification will only apply to Stateless ESX hosts which are under this vCenter cluster. - transport_zone_endpoints (
listofTransportZoneEndPointorNone) – Transport zone endpoints
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionTransportNodeTemplateState(compute_collection_id=None, template_states=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport node state per compute collection
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - compute_collection_id (
strorNone) – Associated compute collection id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - template_states (
listofTransportNodeTemplateStateorNone) – Transport node template states in compute collection This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- compute_collection_id (
-
class
com.vmware.nsx_policy.model_client.ComputeCollectionTransportNodeTemplateStateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport node creation state list
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofComputeCollectionTransportNodeTemplateStateorNone) – State list per compute collection This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeManager(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, credential=None, origin_properties=None, origin_type=None, server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - credential (
vmware.vapi.struct.VapiStructorNone) – Login credentials for the compute manager When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLoginCredential. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLoginCredential. - origin_properties (
listofKeyValuePairorNone) – Key-Value map of additional specific properties of compute manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_type (
str) – Compute manager type like vCenter - server (
str) – IP address or hostname of compute manager format: hostname-or-ip
- links (
-
class
com.vmware.nsx_policy.model_client.ComputeManagerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of compute managers
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofComputeManager) – List of compute managers
- links (
-
class
com.vmware.nsx_policy.model_client.Condition(key=None, member_type=None, operator=None, value=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Condition', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the leaf level condition
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
str) –Possible values are:
Key - member_type (
str) –Possible values are:
Group member type - operator (
str) –Possible values are:
operator - value (
str) – Value - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
KEY_NAME= 'Name'¶
-
KEY_TAG= 'Tag'¶
-
MEMBER_TYPE_LOGICALPORT= 'LogicalPort'¶
-
MEMBER_TYPE_VIRTUALMACHINE= 'VirtualMachine'¶
-
OPERATOR_CONTAINS= 'CONTAINS'¶
-
OPERATOR_EQUALS= 'EQUALS'¶
-
OPERATOR_STARTSWITH= 'STARTSWITH'¶
- key (
-
class
com.vmware.nsx_policy.model_client.ConditionalForwarderZone(source_ip=None, upstream_servers=None, domain_names=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - source_ip (
strorNone) – The source ip used by the fowarder of the zone. If no source ip specified, the ip address of listener of the dns forwarder will be used. format: ipv4 - upstream_servers (
listofstr) – Ip address of the upstream dns servers the dns forwarder accesses. format: ipv4 - domain_names (
listofstr) – A forwarder domain name should be a valid FQDN. If reverse lookup is needed for this zone, reverse lookup domain name like X.in-addr.arpa can be defined. Here the X represents a subnet.
- source_ip (
-
class
com.vmware.nsx_policy.model_client.ConditionalValueConstraintExpression(operator=None, rhs_value=None, value_constraint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the leaf level expression to restrict the target attribute value based on the set of existing values. Generally, used in combination with RelatedAttributeConditionalExpression to constraint the values related to another attribute on the same resource. This object is always used in conjunction with some exression. Example - { "condition" : { "operator":"INCLUDES", "rhs_value": ["/infra/domains/mgw/groups/VCENTER", "/infra/domains/mgw/groups/SRM", "/infra/domains/mgw/groups/NSX"], "value_constraint": { "resource_type": "ValueConstraintExpression", "operator":"EXCLUDES", "values":["/infra/domains/mgw/groups/VCENTER", "/infra/domains/mgw/groups/SRM", "/infra/domains/mgw/groups/NSX"] } }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - operator (
str) –Possible values are:
ConditionalValueConstraintExpression.OPERATOR_INCLUDESConditionalValueConstraintExpression.OPERATOR_EXCLUDESConditionalValueConstraintExpression.OPERATOR_EQUALS
Set operation to constraint values. - rhs_value (
listofstr) – List of values. - value_constraint (
ValueConstraintExpression) – Values to apply the conditional constraint on target.
-
OPERATOR_EQUALS= 'EQUALS'¶
-
OPERATOR_EXCLUDES= 'EXCLUDES'¶
-
OPERATOR_INCLUDES= 'INCLUDES'¶
- operator (
-
class
com.vmware.nsx_policy.model_client.ConfigurationState(details=None, failure_code=None, failure_message=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDescribes status of configuration of an entity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
ConfigurationState.STATE_PENDINGConfigurationState.STATE_IN_PROGRESSConfigurationState.STATE_SUCCESSConfigurationState.STATE_FAILEDConfigurationState.STATE_PARTIAL_SUCCESSConfigurationState.STATE_ORPHANEDConfigurationState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.ConfigurationStateElement(failure_code=None, failure_message=None, state=None, sub_system_address=None, sub_system_id=None, sub_system_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDescribes status of configuration of an entity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
ConfigurationStateElement.STATE_IN_PROGRESSConfigurationStateElement.STATE_SUCCESSConfigurationStateElement.STATE_FAILEDConfigurationStateElement.STATE_PARTIAL_SUCCESS
State of configuration on this sub systemThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- sub_system_address (
strorNone) – URI of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sub_system_id (
strorNone) – Identifier of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sub_system_type (
strorNone) – Type of backing resource on sub system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_SUCCESS= 'success'¶
- failure_code (
-
class
com.vmware.nsx_policy.model_client.ConjunctionOperator(conjunction_operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ConjunctionOperator', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the operators AND or OR
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - conjunction_operator (
str) –Possible values are:
Conjunction Operator Node - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
CONJUNCTION_OPERATOR_AND= 'AND'¶
-
CONJUNCTION_OPERATOR_OR= 'OR'¶
- conjunction_operator (
-
class
com.vmware.nsx_policy.model_client.Connection(dest_element_id=None, number_of_events=None, src_element_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructConnection are edges that provides the information about connectivity between the source and destination elements.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_element_id (
strorNone) – Unique element ID of destination element to which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - number_of_events (
longorNone) – Represents the number of events/flows between the source and destination elements. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_element_id (
strorNone) – Unique element ID of source element from which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- dest_element_id (
-
class
com.vmware.nsx_policy.model_client.Connections(group_connections=None, network_connections=None, process_connections=None, vm_connections=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains the list of VM, process, group and network connections. Depending on the view option specified in ViewTypeQueryParameter appropriate connection information is returned.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - group_connections (
listofGroupConnectionorNone) – List of Group Communications This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - network_connections (
listofNetworkConnectionorNone) – - process_connections (
listofProcessConnectionorNone) – List of process connections This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_connections (
listofVMConnectionorNone) – List of VM connections This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- group_connections (
-
class
com.vmware.nsx_policy.model_client.ConnectivityAdvancedConfig(connectivity=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAdvanced configuration for Policy connectivity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: connectivity ( strorNone) –Possible values are:
Connectivity configuration to manually connect (ON) or disconnect (OFF) a logical entity from network topology.
-
CONNECTIVITY_OFF= 'OFF'¶
-
CONNECTIVITY_ON= 'ON'¶
-
-
class
com.vmware.nsx_policy.model_client.ConsolidatedRealizedStatus(consolidated_status=None, consolidated_status_per_enforcement_point=None, intent_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents aggregated realized status for intent entity across associated realized entities and enforcement points.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - consolidated_status (
ConsolidatedStatusorNone) – Consolidated state across enforcement points. - consolidated_status_per_enforcement_point (
listofConsolidatedStatusPerEnforcementPointorNone) – Aggregated consolidated status by enforcement point - intent_path (
strorNone) – Intent path of the object representing this consolidated state
- consolidated_status (
-
class
com.vmware.nsx_policy.model_client.ConsolidatedStatus(consolidated_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents consolidated status of an object
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: consolidated_status ( strorNone) – Possible values could be SUCCESS, ERROR, UNAVAILABLE This list is not exhaustive.
-
class
com.vmware.nsx_policy.model_client.ConsolidatedStatusPerEnforcementPoint(consolidated_status=None, enforcement_point_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized status consolidated by enfocement point
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - consolidated_status (
ConsolidatedStatusorNone) – Detailed consolidated realized status for intent object - enforcement_point_id (
strorNone) – Enforcement point id used to consolidate state
- consolidated_status (
-
class
com.vmware.nsx_policy.model_client.Constraint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, constraint_expression=None, message=None, target=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructConstraint object to constraint any attribute on a resource based on specified expression. Example- Restrict the allowed services in Edge Communication Entry to list of services, if the destinationGroups contain vCenter. { "target":{ "target_resource_type":"CommunicationEntry", "attribute":"services", "path_prefix":"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries" } "constraint_expression":{ "related_attribute":{ "attribute":"destinationGroups" } "condition":{ "operator":"INCLUDES", "rhs_value":{"vCenter"} "value_constraint":{ "operator":"ALLOW", "values":{"/ref/services/HTTPS", "/ref/services/HTTOP", …} } } } }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - constraint_expression (
vmware.vapi.struct.VapiStruct) – Expression to constrain the target attribute value. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inConstraintExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inConstraintExpression. - message (
strorNone) – User friendly message to be shown to users upon violation. - target (
ConstraintTarget) – Target resource attribute details.
- links (
-
class
com.vmware.nsx_policy.model_client.ConstraintExpression(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ConstraintExpression', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAll the types of the expression extend from this abstract class. This is present for extensibility.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_ENTITYINSTANCECOUNTCONSTRAINTEXPRESSION= 'EntityInstanceCountConstraintExpression'¶
-
RESOURCE_TYPE_FIELDSANITYCONSTRAINTEXPRESSION= 'FieldSanityConstraintExpression'¶
-
RESOURCE_TYPE_RELATEDATTRIBUTECONDITIONALEXPRESSION= 'RelatedAttributeConditionalExpression'¶
-
RESOURCE_TYPE_VALUECONSTRAINTEXPRESSION= 'ValueConstraintExpression'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ConstraintListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Constraints
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofConstraint) – Constraint list results
- links (
-
class
com.vmware.nsx_policy.model_client.ConstraintTarget(attribute=None, path_prefix=None, target_resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructResource attribute on which constraint should be applied. Example - sourceGroups attribute of Edge CommunicationEntry to be restricted, is given as: { "target_resource_type":"CommunicationEntry", "attribute":"sourceGroups", "path_prefix":"/infra/domains/vmc-domain/edge-communication-maps/default/communication-entries" }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - attribute (
strorNone) – Attribute name of the target entity. - path_prefix (
strorNone) – Path prefix of the entity to apply constraint. This is required to further disambiguiate if multiple policy entities share the same resource type. Example - Edge FW and DFW use the same resource type CommunicationMap, CommunicationEntry, Group, etc. - target_resource_type (
str) – Resource type of the target entity.
- attribute (
-
class
com.vmware.nsx_policy.model_client.ContainerConfiguration(labels=None, navigation=None, span=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ContainerConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a container to group widgets that belong to a common category or have a common purpose.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - labels (
listofLabelorNone) – Labels for the container. - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - span (
longorNone) – Represents the horizontal span of the container. format: int32 - widgets (
listofWidgetItemorNone) – If not specified, creates an empty container. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- labels (
-
class
com.vmware.nsx_policy.model_client.ControlClusterNodeStatus(control_cluster_status=None, mgmt_connection_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - control_cluster_status (
strorNone) –Possible values are:
ControlClusterNodeStatus.CONTROL_CLUSTER_STATUS_CONNECTEDControlClusterNodeStatus.CONTROL_CLUSTER_STATUS_DISCONNECTEDControlClusterNodeStatus.CONTROL_CLUSTER_STATUS_UNKNOWN
Status of this node’s connection to the control clusterThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- mgmt_connection_status (
MgmtConnStatusorNone) – Status of this node’s management plane connection
-
CONTROL_CLUSTER_STATUS_CONNECTED= 'CONNECTED'¶
-
CONTROL_CLUSTER_STATUS_DISCONNECTED= 'DISCONNECTED'¶
-
CONTROL_CLUSTER_STATUS_UNKNOWN= 'UNKNOWN'¶
- control_cluster_status (
-
class
com.vmware.nsx_policy.model_client.ControlConnStatus(control_node_ip=None, failure_status=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - control_node_ip (
strorNone) – IP address of the control Node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_status (
strorNone) –Possible values are:
ControlConnStatus.FAILURE_STATUS_CONNECTION_REFUSEDControlConnStatus.FAILURE_STATUS_INCOMPLETE_HOST_CERTControlConnStatus.FAILURE_STATUS_INCOMPLETE_CONTROLLER_CERTControlConnStatus.FAILURE_STATUS_CONTROLLER_REJECTED_HOST_CERTControlConnStatus.FAILURE_STATUS_HOST_REJECTED_CONTROLLER_CERTControlConnStatus.FAILURE_STATUS_KEEP_ALIVE_TIMEOUTControlConnStatus.FAILURE_STATUS_OTHER_SSL_ERRORControlConnStatus.FAILURE_STATUS_OTHER_ERROR
Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- status (
strorNone) –Possible values are:
Status of the control Node for e.g UP, DOWN.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
FAILURE_STATUS_CONNECTION_REFUSED= 'CONNECTION_REFUSED'¶
-
FAILURE_STATUS_CONTROLLER_REJECTED_HOST_CERT= 'CONTROLLER_REJECTED_HOST_CERT'¶
-
FAILURE_STATUS_HOST_REJECTED_CONTROLLER_CERT= 'HOST_REJECTED_CONTROLLER_CERT'¶
-
FAILURE_STATUS_INCOMPLETE_CONTROLLER_CERT= 'INCOMPLETE_CONTROLLER_CERT'¶
-
FAILURE_STATUS_INCOMPLETE_HOST_CERT= 'INCOMPLETE_HOST_CERT'¶
-
FAILURE_STATUS_KEEP_ALIVE_TIMEOUT= 'KEEP_ALIVE_TIMEOUT'¶
-
FAILURE_STATUS_OTHER_ERROR= 'OTHER_ERROR'¶
-
FAILURE_STATUS_OTHER_SSL_ERROR= 'OTHER_SSL_ERROR'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UP= 'UP'¶
- control_node_ip (
-
class
com.vmware.nsx_policy.model_client.ControllerClusterRoleConfig(type=None, control_cluster_listen_addr=None, control_plane_listen_addr=None, host_msg_client_info=None, mpa_msg_client_info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - type (
strorNone) –Possible values are:
ControllerClusterRoleConfig.TYPE_MANAGEMENTCLUSTERROLECONFIGType of this role configuration
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- control_cluster_listen_addr (
ServiceEndpointorNone) – The IP and port for the control cluster service on this node - control_plane_listen_addr (
ServiceEndpointorNone) – The IP and port for the control plane service on this node - host_msg_client_info (
MsgClientInfoorNone) – - mpa_msg_client_info (
MsgClientInfoorNone) –
-
TYPE_CONTROLLERCLUSTERROLECONFIG= 'ControllerClusterRoleConfig'¶
-
TYPE_MANAGEMENTCLUSTERROLECONFIG= 'ManagementClusterRoleConfig'¶
- type (
-
class
com.vmware.nsx_policy.model_client.ControllerClusterStatus(status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: status ( strorNone) –Possible values are:
ControllerClusterStatus.STATUS_UNSTABLEControllerClusterStatus.STATUS_STABLEControllerClusterStatus.STATUS_UNKNOWN
The current status of the controller clusterThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATUS_STABLE= 'STABLE'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UNSTABLE= 'UNSTABLE'¶
-
class
com.vmware.nsx_policy.model_client.ControllerNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None, role_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_properties (
listofNodeInterfacePropertiesorNone) – Array of Node interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_statistics (
listofNodeInterfaceStatisticsPropertiesorNone) – Array of Node network interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_status (
ClusterNodeStatusorNone) – - node_status_properties (
listofNodeStatusPropertiesorNone) – Time series of the node’s system properties - role_config (
ControllerClusterRoleConfigorNone) –
- display_name (
-
class
com.vmware.nsx_policy.model_client.CpuCoreConfigForEnhancedNetworkingStackSwitch(num_lcores=None, numa_node_index=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNon Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - num_lcores (
long) – Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node format: int32 - numa_node_index (
long) – Unique index of the Non Uniform Memory Access (NUMA) node format: int32
- num_lcores (
-
class
com.vmware.nsx_policy.model_client.Crl(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, details=None, pem_encoded=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - details (
X509CrlorNone) – details of the X509Crl object - pem_encoded (
str) – pem encoded crl data
- links (
-
class
com.vmware.nsx_policy.model_client.CrlList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCrl queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCrlorNone) – CRL list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.CrlObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pem_encoded=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - pem_encoded (
str) – pem encoded crl data
- links (
-
class
com.vmware.nsx_policy.model_client.CryptoAlgorithm(key_size=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key_size (
listoflongorNone) – supported key sizes for the algorithm format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – crypto algorithm name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- key_size (
-
class
com.vmware.nsx_policy.model_client.Csr(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, algorithm=None, key_size=None, pem_encoded=None, subject=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - algorithm (
str) –Possible values are:
Cryptographic algorithm(asymmetric ) used by the public key for data encryption
- key_size (
long) – size measured in bits of the public key used in a cryptographic algorithm format: int64 - pem_encoded (
strorNone) – pem encoded certificate data This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subject (
Principal) – the certificate owner’s information (CN, O, OU, C, ST, L)
-
ALGORITHM_DSA= 'DSA'¶
-
ALGORITHM_RSA= 'RSA'¶
- links (
-
class
com.vmware.nsx_policy.model_client.CsrList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCsr queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCsr) – CSR list
- links (
-
class
com.vmware.nsx_policy.model_client.CsvListResult(file_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase type for CSV result.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: file_name ( strorNone) – File name set by HTTP server if API returns CSV result as a file.
-
class
com.vmware.nsx_policy.model_client.CsvRecord¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase type for CSV records.
Tip
The arguments are used to initialize data attributes with the same names.
-
class
com.vmware.nsx_policy.model_client.CurrentBackupOperationStatus(backup_id=None, current_step=None, current_step_message=None, end_time=None, operation_type=None, start_time=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCurrent backup operation status
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - backup_id (
strorNone) – Unique identifier of current backup - current_step (
strorNone) –Possible values are:
CurrentBackupOperationStatus.CURRENT_STEP_CLUSTER_BACKUPCurrentBackupOperationStatus.CURRENT_STEP_NODE_BACKUP
Current step of operation - current_step_message (
strorNone) – Additional human-readable status information about current step - end_time (
longorNone) – Time when operation is expected to end format: int64 - operation_type (
str) –Possible values are:
Type of operation that is in progress. Returns none if no operation is in progress, in which case none of the other fields will be set.
- start_time (
longorNone) – Time when operation was started format: int64
-
CURRENT_STEP_CLUSTER_BACKUP= 'BACKUP_CREATING_CLUSTER_BACKUP'¶
-
CURRENT_STEP_NODE_BACKUP= 'BACKUP_CREATING_NODE_BACKUP'¶
-
OPERATION_TYPE_BACKUP= 'BACKUP'¶
-
OPERATION_TYPE_NONE= 'NONE'¶
- backup_id (
-
class
com.vmware.nsx_policy.model_client.DSRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - action (
str) –Possible values are:
DSRule.ACTION_ALLOWDSRule.ACTION_DROPDSRule.ACTION_REJECTDSRule.ACTION_REDIRECTDSRule.ACTION_DO_NOT_REDIRECT
Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP - Drop any packet when a rule with this action gets a match. Packets won’t go further(Used by Firewall). REJECT - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion).
- applied_tos (
listofResourceReferenceorNone) – List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any. - destinations (
listofResourceReferenceorNone) – List of the destinations. Null will be treated as any. - destinations_excluded (
boolorNone) – Negation of the destination. - direction (
strorNone) –Possible values are:
Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.
- disabled (
boolorNone) – Flag to disable rule. Disabled will only be persisted but never provisioned/realized. - ip_protocol (
strorNone) –Possible values are:
Type of IP packet that should be matched while enforcing the rule. - is_default (
boolorNone) – Flag to indicate whether rule is default. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - notes (
strorNone) – User notes specific to the rule. - rule_tag (
strorNone) – User level field which will be printed in CLI and packet logs. - services (
listofDSServiceorNone) – List of the services. Null will be treated as any. - sources (
listofResourceReferenceorNone) – List of sources. Null will be treated as any. - sources_excluded (
boolorNone) – Negation of the source.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DO_NOT_REDIRECT= 'DO_NOT_REDIRECT'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REDIRECT= 'REDIRECT'¶
-
ACTION_REJECT= 'REJECT'¶
-
DIRECTION_IN= 'IN'¶
-
DIRECTION_IN_OUT= 'IN_OUT'¶
-
DIRECTION_OUT= 'OUT'¶
-
IP_PROTOCOL_IPV4= 'IPV4'¶
-
IP_PROTOCOL_IPV4_IPV6= 'IPV4_IPV6'¶
-
IP_PROTOCOL_IPV6= 'IPV6'¶
- links (
-
class
com.vmware.nsx_policy.model_client.DSRuleState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
DSRuleState.STATE_PENDINGDSRuleState.STATE_IN_PROGRESSDSRuleState.STATE_SUCCESSDSRuleState.STATE_FAILEDDSRuleState.STATE_PARTIAL_SUCCESSDSRuleState.STATE_ORPHANEDDSRuleState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- revision_desired (
longorNone) – revision number of the desired state format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.DSSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo. - is_default (
boolorNone) – It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
str) –Possible values are:
Type of the rules which a section can contain. Only homogeneous sections are supported.
- stateful (
bool) – Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.
-
SECTION_TYPE_L3REDIRECT= 'L3REDIRECT'¶
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- links (
-
class
com.vmware.nsx_policy.model_client.DSSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDSSectionorNone) – List of the distributed service sections. The list has to be homogenous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.DSSectionState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
DSSectionState.STATE_PENDINGDSSectionState.STATE_IN_PROGRESSDSSectionState.STATE_SUCCESSDSSectionState.STATE_FAILEDDSSectionState.STATE_PARTIAL_SUCCESSDSSectionState.STATE_ORPHANEDDSSectionState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- revision_desired (
longorNone) – revision number of the desired state format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.DSService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - service (
vmware.vapi.struct.VapiStructorNone) – Distributed Service API accepts raw protocol and ports as part of NS service element in Distributed Service Rule that describes traffic corresponding to an NSService. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.DailyTelemetrySchedule(hour_of_day=None, minutes=None, frequency_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - hour_of_day (
long) – Hour at which data will be collected. Specify a value between 0 through 23. format: int64 - minutes (
longorNone) – Minute at which data will be collected. Specify a value between 0 through 59. format: int64 - frequency_type (
str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.
- hour_of_day (
-
class
com.vmware.nsx_policy.model_client.DataTypeCollectionConfiguration(collection_frequency=None, data_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructData type collection configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - collection_frequency (
long) – The frequency in seconds at which data is collected format: int64 - data_type (
str) –Possible values are:
DataTypeCollectionConfiguration.DATA_TYPE_STATUSDataTypeCollectionConfiguration.DATA_TYPE_STATISTICS
Defines the type of data being collected
-
DATA_TYPE_STATISTICS= 'STATISTICS'¶
-
DATA_TYPE_STATUS= 'STATUS'¶
- collection_frequency (
-
class
com.vmware.nsx_policy.model_client.Datasource(display_name=None, urls=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn instance of a datasource configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
str) – Name of a datasource instance. - urls (
listofUrlAlias) – Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.
- display_name (
-
class
com.vmware.nsx_policy.model_client.DeploymentConfig(placement_type='DeploymentConfig')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: placement_type ( str) –Possible values are:
-
PLACEMENT_TYPE_VSPHEREDEPLOYMENTCONFIG= 'VsphereDeploymentConfig'¶
-
-
class
com.vmware.nsx_policy.model_client.DeploymentSpec(fabric_module_version=None, versioned_deployment_specs=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDeployment spec is a specific version of fabric module
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - fabric_module_version (
str) – version of fabric module - versioned_deployment_specs (
listofVersionedDeploymentSpec) – List of Versioned deployment specs
- fabric_module_version (
-
class
com.vmware.nsx_policy.model_client.DeploymentTemplate(attributes=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDeployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - attributes (
listofAttributeorNone) – List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. - name (
strorNone) – Deployment Template name.
- attributes (
-
class
com.vmware.nsx_policy.model_client.DeploymentZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_points=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical grouping of enforcement points
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforcement_points (
listofEnforcementPointorNone) – Logical grouping of enforcement points
- links (
-
class
com.vmware.nsx_policy.model_client.DeploymentZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Deployment Zones
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDeploymentZone) – Deployment Zones
- links (
-
class
com.vmware.nsx_policy.model_client.DestinationFilteringConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, customer_id=None, enabled=None, provider_url=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIt is used to configure the reputation and category provider. It can also be used to enable or disable the destination filtering feature by setting the enable property.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - customer_id (
str) – The unique ID assigned to a customer. - enabled (
boolorNone) – Flag to enable or disable the feature. - provider_url (
str) – URL of the provider which provides the reputation and category databases.
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpFilter(client_block_enabled=None, server_block_enabled=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDHCP filtering configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - client_block_enabled (
bool) – Indicates whether DHCP client blocking is enabled - server_block_enabled (
bool) – Indicates whether DHCP server blocking is enabled
- client_block_enabled (
-
class
com.vmware.nsx_policy.model_client.DhcpIpPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None, allocation_ranges=None, error_threshold=None, warning_threshold=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - gateway_ip (
strorNone) – gateway ip format: ip - lease_time (
longorNone) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64 - options (
DhcpOptionsorNone) – If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level. - allocation_ranges (
listofIpPoolRange) – ip-ranges - error_threshold (
longorNone) – error threshold, valid [80-100], default 100 format: int64 - warning_threshold (
longorNone) – warning threshold, valid [50-80], default 80 format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpIpPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDhcpIpPool) – paginated list of dhcp ip pools
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpOption121(static_routes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: static_routes ( listofClasslessStaticRoute) – dhcp classless static routes
-
class
com.vmware.nsx_policy.model_client.DhcpOptions(option121=None, others=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - option121 (
DhcpOption121orNone) – option 121 - others (
listofGenericDhcpOptionorNone) –
- option121 (
-
class
com.vmware.nsx_policy.model_client.DhcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, edge_cluster_id=None, edge_cluster_member_indexes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - edge_cluster_id (
str) – edge cluster uuid - edge_cluster_member_indexes (
listoflongorNone) – If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support. If both the member indexes are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current dhcp server states will be lost, which could cause the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a,b] to [a,y]. format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDhcpProfile) – paginated list of dhcp profiles
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpRelayProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, server_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - server_addresses (
listofstr) –
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpRelayProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDhcpRelayProfile) – Dhcp relay profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpRelayService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dhcp_relay_profile_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - dhcp_relay_profile_id (
str) – dhcp relay profile referenced by the dhcp relay service
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpRelayServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDhcpRelayService) – Dhcp relay service list results
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpStaticBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None, host_name=None, ip_address=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - gateway_ip (
strorNone) – gateway ip format: ip - lease_time (
longorNone) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64 - options (
DhcpOptionsorNone) – If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level. - host_name (
strorNone) – host name format: hostname - ip_address (
str) – ip addres format: ip - mac_address (
str) – mac address
- links (
-
class
com.vmware.nsx_policy.model_client.DhcpStaticBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDhcpStaticBinding) – paginated list of dhcp static bindings
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryAdDomain(base_distinguished_name=None, sync_settings=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive Directory Domain
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - base_distinguished_name (
strorNone) – Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain’s distinguished name (DN) and is typically referred to as the NC head. - sync_settings (
DirectoryDomainSyncSettingsorNone) – Each domain sync settings can be changed using this object. It is not required since there are default values used if there is no specification for this object. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Domain resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdDomain is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - name (
str) – Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.
- base_distinguished_name (
-
class
com.vmware.nsx_policy.model_client.DirectoryAdGroup(object_guid=None, secure_id=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None, domain_id=None, domain_sync_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - object_guid (
str) – GUID is a 128-bit value that is unique not only in the enterprise but also across the world. GUIDs are assigned to every object created by Active Directory, not just User and Group objects. - secure_id (
str) – A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components - The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - distinguished_name (
str) – Directory group distinguished name - domain_id (
str) – Domain ID this directory group belongs to. - domain_sync_node_id (
str) – Domain sync node under which this directory group is located.
- object_guid (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DirectoryDomain', tags=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDirectory Domain
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Domain resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdDomain is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - name (
str) – Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of Directory Domain
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – List of Directory Domains When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inDirectoryDomain. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inDirectoryDomain.
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainSyncNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, distinguished_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDirectory Domain Synchronization Nodes
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - distinguished_name (
str) – Distinguished name of the domain sync node
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainSyncNodeListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of Directory Domain Synchronization Nodes
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDirectoryDomainSyncNode) – List of Directory Domain Synchronization Nodes
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainSyncRemoteNodes(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of Directory Domain sync remote nodes
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofstr) – Directory domain sync remote node candidate
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainSyncSettings(delta_sync_interval=None, full_sync_cron_expr=None, sync_entire_domain=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDomain synchronization settings
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - delta_sync_interval (
longorNone) – Directory domain delta synchronization interval time between two delta sync in minutes. format: int64 - full_sync_cron_expr (
strorNone) – Directory domain full synchronization schedule using cron expression. For example, cron expression "0 0 12 ? \* SUN \*" means full sync is scheduled every Sunday midnight. If this object is null, it means there is no background cron job running for full sync. - sync_entire_domain (
boolorNone) – This flag will decide whether to synchronize the directory objects under entire domain or configured synchronization nodes.
- delta_sync_interval (
-
class
com.vmware.nsx_policy.model_client.DirectoryDomainSyncStats(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, avg_delta_sync_time=None, avg_full_sync_time=None, current_state=None, current_state_begin_time=None, num_delta_sync=None, num_full_sync=None, prev_sync_end_time=None, prev_sync_status=None, prev_sync_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDirectory Domain Synchronization Statistics
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - avg_delta_sync_time (
longorNone) – All the historical delta sync are counted in calculating the average delta sync time in seconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - avg_full_sync_time (
longorNone) – All the historical full sync are counted in calculating the average full sync time in seconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - current_state (
strorNone) –Possible values are:
DirectoryDomainSyncStats.CURRENT_STATE_IDLEDirectoryDomainSyncStats.CURRENT_STATE_FULL_SYNCDirectoryDomainSyncStats.CURRENT_STATE_DELTA_SYNC
Current running state of the directory domain in synchronization life cycle. It could be one of the following three states. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- current_state_begin_time (
longorNone) – Since what time the current state has begun. The time is expressed in millisecond epoch time. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - num_delta_sync (
longorNone) – number of historical delta sync initiated either by system or by API request. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - num_full_sync (
longorNone) – number of historical full sync initiated either by system or by API request. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - prev_sync_end_time (
longorNone) – Directory domain previous sync ending time expressed in millisecond epoch time. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - prev_sync_status (
strorNone) –Possible values are:
DirectoryDomainSyncStats.PREV_SYNC_STATUS_SUCCESSDirectoryDomainSyncStats.PREV_SYNC_STATUS_FAILUREDirectoryDomainSyncStats.PREV_SYNC_STATUS_UNKNOWN
Directory domain previous sync status. It could be one of the following two states. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- prev_sync_type (
strorNone) –Possible values are:
DirectoryDomainSyncStats.PREV_SYNC_TYPE_IDLEDirectoryDomainSyncStats.PREV_SYNC_TYPE_FULL_SYNCDirectoryDomainSyncStats.PREV_SYNC_TYPE_DELTA_SYNC
Directory domain previous sync type. It could be one of the following three states. Right after the directory domain is configured, this field is set to IDLE. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
CURRENT_STATE_DELTA_SYNC= 'DELTA_SYNC'¶
-
CURRENT_STATE_FULL_SYNC= 'FULL_SYNC'¶
-
CURRENT_STATE_IDLE= 'IDLE'¶
-
PREV_SYNC_STATUS_FAILURE= 'FAILURE'¶
-
PREV_SYNC_STATUS_SUCCESS= 'SUCCESS'¶
-
PREV_SYNC_STATUS_UNKNOWN= 'UNKNOWN'¶
-
PREV_SYNC_TYPE_DELTA_SYNC= 'DELTA_SYNC'¶
-
PREV_SYNC_TYPE_FULL_SYNC= 'FULL_SYNC'¶
-
PREV_SYNC_TYPE_IDLE= 'IDLE'¶
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DirectoryGroup', tags=None, distinguished_name=None, domain_id=None, domain_sync_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - distinguished_name (
str) – Directory group distinguished name - domain_id (
str) – Domain ID this directory group belongs to. - domain_sync_node_id (
str) – Domain sync node under which this directory group is located.
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryGroupListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – Directory group list When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inDirectoryGroup. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inDirectoryGroup.
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryGroupMember(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, group_distinguished_name=None, group_id=None, member_group_distinguished_name=None, member_group_id=None, nested=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - group_distinguished_name (
str) – Directory group distinguished name this group member belongs to. - group_id (
str) – Directory group id this group member belongs to - member_group_distinguished_name (
str) – Directory group name this group member owns - member_group_id (
str) – Directory group id this group member owns - nested (
bool) – Whether this member group is a directory member of the parent group speicified by group_id or a nested member group which parent group is also member group of the parent group speicified by group_id.
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryGroupMemberListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDirectoryGroupMember) – Directory group member list
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryLdapServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, host=None, password=None, port=None, protocol=None, thumbprint=None, username=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLdap Server of Directory Domain
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Whether this directory LDAP server is enabled or not. - host (
str) – Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization. format: ip-or-hostname - password (
str) – Directory LDAP server connection password. - port (
longorNone) – Directory LDAP server connection TCP/UDP port. format: int64 - protocol (
strorNone) –Possible values are:
Directory LDAP server connection protocol which is either LDAP or LDAPS.
- thumbprint (
strorNone) – Directory LDAP server certificate thumbprint used in secure LDAPS connection. - username (
str) – Directory LDAP server connection user name.
-
PROTOCOL_LDAP= 'LDAP'¶
-
PROTOCOL_LDAPS= 'LDAPS'¶
- links (
-
class
com.vmware.nsx_policy.model_client.DirectoryLdapServerListResults(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of Directory Domain LDAP servers
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDirectoryLdapServer) – List of Directory Domain Ldap Servers
- links (
-
class
com.vmware.nsx_policy.model_client.DiscoveredNode(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, certificate=None, cm_local_id=None, external_id=None, hardware_id=None, ip_addresses=None, node_type=None, origin_id=None, origin_properties=None, os_type=None, os_version=None, parent_compute_collection=None, stateless=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - last_sync_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Display name of discovered node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - certificate (
strorNone) – Certificate of the discovered node - cm_local_id (
strorNone) – Local Id of the discovered node in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – External id of the discovered node, ex. a mo-ref from VC This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - hardware_id (
strorNone) – Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the the discovered node. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_type (
strorNone) – Discovered Node type like Host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_id (
strorNone) – Id of the compute manager from where this node was discovered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - origin_properties (
listofKeyValuePairorNone) – Key-Value map of additional specific properties of discovered node in the Compute Manager This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os_type (
strorNone) – OS type of the discovered node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os_version (
strorNone) – OS version of the discovered node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - parent_compute_collection (
strorNone) – External id of the compute collection to which this node belongs This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - stateless (
boolorNone) – The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.DiscoveredNodeInterfaceProperties(connected_switch=None, interface_id=None, physical_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNetwork interface properties of discovered node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - connected_switch (
strorNone) – Switch name which is connected to nic, switch can be opaque, proxyHostSwitch or virtual - interface_id (
strorNone) – Id of the network interface - physical_address (
strorNone) – Mac address of the interface
- connected_switch (
-
class
com.vmware.nsx_policy.model_client.DiscoveredNodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDiscovered Node list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDiscoveredNode) – Discovered Node list results
- links (
-
class
com.vmware.nsx_policy.model_client.DiscoveredNodeNetworkInterfaces(discovered_node_id=None, network_interfaces=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAll the network interfaces of the discovered node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - discovered_node_id (
str) – Id of the discovered node - network_interfaces (
listofDiscoveredNodeInterfacePropertiesorNone) – Network interfaces of the node
- discovered_node_id (
-
class
com.vmware.nsx_policy.model_client.DiscoveredResource(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase class for resources that are discovered and automatically updated
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - last_sync_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- links (
-
class
com.vmware.nsx_policy.model_client.DiscoverySession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains the details of selected application/domain discovery session
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.DiscoverySessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of discovery sessions
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDiscoverySession) – Discovery session list results
- links (
-
class
com.vmware.nsx_policy.model_client.DnsForwarder(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cache_size=None, conditional_forwarders=None, default_forwarder=None, listener_ip=None, log_level=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cache_size (
longorNone) – One dns answer cache entry will consume ~120 bytes. Hence 1 KB cache size can cache ~8 dns answer entries, and the default 1024 KB cache size can hold ~8k dns answer entries. format: int32 - conditional_forwarders (
listofConditionalForwarderZoneorNone) – The conditional zone forwarders. During matching a zone forwarder, the dns forwarder will use the conditional fowarder with the longest domain name that matches the query. - default_forwarder (
ForwarderZone) – The default zone forwarder that catches all other domain names except those matched by conditional forwarder zone. - listener_ip (
str) – The ip address the dns forwarder listens on. It can be an ip address already owned by the logical-router uplink port or router-link, or a loopback port ip address. But it can not be a downlink port address. User needs to ensure the address is reachable via router or NAT from both client VMs and upstream servers. User will need to create Firewall rules if needed to allow such traffic on a Tier-1 or Tier-0. format: ipv4 - log_level (
strorNone) –Possible values are:
DnsForwarder.LOG_LEVEL_DEBUGDnsForwarder.LOG_LEVEL_INFODnsForwarder.LOG_LEVEL_WARNINGDnsForwarder.LOG_LEVEL_ERRORDnsForwarder.LOG_LEVEL_FATAL
Log level of the dns forwarder - logical_router_id (
str) – Specify the LogicalRouter where the DnsForwarder runs. The HA mode of the hosting LogicalRouter must be Active/Standby.
-
LOG_LEVEL_DEBUG= 'DEBUG'¶
-
LOG_LEVEL_ERROR= 'ERROR'¶
-
LOG_LEVEL_FATAL= 'FATAL'¶
-
LOG_LEVEL_INFO= 'INFO'¶
-
LOG_LEVEL_WARNING= 'WARNING'¶
- links (
-
class
com.vmware.nsx_policy.model_client.DnsForwarderListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDnsForwarder) – Paginated list of dns forwarders
- links (
-
class
com.vmware.nsx_policy.model_client.Domain(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, communication_maps=None, groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - communication_maps (
listofCommunicationMaporNone) – List of communication maps under this domain. - groups (
listofGrouporNone) – This field is used while creating or updating the Domain. Please take a look at the UpdateTenant API documentation for details.
- links (
-
class
com.vmware.nsx_policy.model_client.DomainDeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBinding of domains to the enforcement point.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforcement_point_path (
str) – Path of enforcement point on which domain will be deployed
- links (
-
class
com.vmware.nsx_policy.model_client.DomainDeploymentMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Domain Deployment map
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDomainDeploymentMap) – Domain Deployment Map
- links (
-
class
com.vmware.nsx_policy.model_client.DomainListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Domains
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofDomain) – Domain list results
- links (
-
class
com.vmware.nsx_policy.model_client.DonutConfiguration(display_count=None, label=None, navigation=None, sections=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='DonutConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents configuration of a Donut
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_count (
boolorNone) – If true, displays the count of entities in the donut - label (
LabelorNone) – Displayed at the middle of the donut, by default. It labels the entities of donut. - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - sections (
listofDonutSection) – Sections - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- display_count (
-
class
com.vmware.nsx_policy.model_client.DonutPart(field=None, label=None, render_configuration=None, tooltip=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an entity or portion to be plotted on a donut or stats chart.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - field (
str) – A numerical value that represents the portion or entity of the donut or stats chart. - label (
LabelorNone) – If a section ‘template’ holds this donut or stats part, then the label is auto-generated from the fetched field values after applying the template. - render_configuration (
listofRenderConfigurationorNone) – Additional rendering or conditional evaluation of the field values to be performed, if any. - tooltip (
listofTooltiporNone) – Multi-line text to be shown on tooltip while hovering over the portion.
- field (
-
class
com.vmware.nsx_policy.model_client.DonutSection(parts=None, row_list_field=None, template=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents high level logical grouping of portions or segments of a donut / stats chart.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - parts (
listofDonutPart) – Array of portions or parts of the donut or stats chart. - row_list_field (
strorNone) – Field of the root of the api result set for forming parts. - template (
boolorNone) – If true, the section will be appled as template for forming parts. Only one part will be formed from each element of ‘row_list_field’.
- parts (
-
class
com.vmware.nsx_policy.model_client.Dscp(mode=None, priority=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDscp value is ignored in case of ‘TRUSTED’ DscpMode.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - mode (
strorNone) –Possible values are:
Trust settings - priority (
longorNone) – Internal Forwarding Priority format: int32
-
MODE_TRUSTED= 'TRUSTED'¶
-
MODE_UNTRUSTED= 'UNTRUSTED'¶
- mode (
-
class
com.vmware.nsx_policy.model_client.EULAAcceptance(acceptance=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIndicate the status of End User License Agreement acceptance
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: acceptance ( bool) – End User License Agreement acceptance status
-
class
com.vmware.nsx_policy.model_client.EULAContent(content=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEnd User License Agreement content
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: content ( strorNone) – End User License Agreement content
-
class
com.vmware.nsx_policy.model_client.EdgeCluster(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cluster_profile_bindings=None, deployment_type=None, member_node_type=None, members=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cluster_profile_bindings (
listofClusterProfileTypeIdEntryorNone) – Edge cluster profile bindings - deployment_type (
strorNone) –Possible values are:
EdgeCluster.DEPLOYMENT_TYPE_VIRTUAL_MACHINEEdgeCluster.DEPLOYMENT_TYPE_PHYSICAL_MACHINEEdgeCluster.DEPLOYMENT_TYPE_UNKNOWN
This field is a readonly field which shows the deployment_type of members. It returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE| PHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE. It returns HYBRID if the cluster contains edge members of both types VIRTUAL_MACHINE and PHYSICAL_MACHINE. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- member_node_type (
strorNone) –Possible values are:
EdgeCluster.MEMBER_NODE_TYPE_EDGE_NODEEdgeCluster.MEMBER_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODEEdgeCluster.MEMBER_NODE_TYPE_UNKNOWN
Edge cluster is homogenous collection of transport nodes. Hence all transport nodes of the cluster must be of same type. This readonly field shows the type of transport nodes. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- members (
listofEdgeClusterMemberorNone) – EdgeCluster only supports homogeneous members. These member should be backed by either EdgeNode or PublicCloudGatewayNode. TransportNode type of these nodes should be the same. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is recommended to be the same. EdgeCluster supports members of different deployment types.
-
DEPLOYMENT_TYPE_PHYSICAL_MACHINE= 'PHYSICAL_MACHINE'¶
-
DEPLOYMENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
DEPLOYMENT_TYPE_VIRTUAL_MACHINE= 'VIRTUAL_MACHINE'¶
-
MEMBER_NODE_TYPE_EDGE_NODE= 'EDGE_NODE'¶
-
MEMBER_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
MEMBER_NODE_TYPE_UNKNOWN= 'UNKNOWN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.EdgeClusterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofEdgeCluster) – Edge cluster list results
- links (
-
class
com.vmware.nsx_policy.model_client.EdgeClusterMember(description=None, display_name=None, member_index=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - description (
strorNone) – description of edge cluster member - display_name (
strorNone) – display name of edge cluster member - member_index (
longorNone) – System generated index for cluster member format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
str) – Identifier of the transport node backed by an Edge node
- description (
-
class
com.vmware.nsx_policy.model_client.EdgeClusterMemberAllocationPool(allocation_pool_type='EdgeClusterMemberAllocationPool')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: allocation_pool_type ( str) –Possible values are:
Types of logical router allocation pool based on services
-
ALLOCATION_POOL_TYPE_LOADBALANCERALLOCATIONPOOL= 'LoadBalancerAllocationPool'¶
-
class
com.vmware.nsx_policy.model_client.EdgeClusterMemberAllocationProfile(allocation_pool=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: allocation_pool ( vmware.vapi.struct.VapiStructorNone) – Logical router allocation can be tracked for specific services and services may have their own hard limits and allocation sizes. For example load balancer pool should be specified if load balancer service will be attached to logical router. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inEdgeClusterMemberAllocationPool. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inEdgeClusterMemberAllocationPool.
-
class
com.vmware.nsx_policy.model_client.EdgeClusterMemberListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofEdgeClusterMember) – edge cluster member list results
- links (
-
class
com.vmware.nsx_policy.model_client.EdgeCommunicationMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, communication_entries=None, precedence=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains ordered list of CommunicationEntries for EdgeCommunicationMap
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - category (
strorNone) – Policy framework provides four pre-defined categories for classifying a communication map. They are "Emergency", "Infrastructure" "Environmental" and "Application". There is a pre-determined order in which the policy framework manages the priority of these communication maps. Emergency category has the highest priority followed by Infrastructure, Environmental and then Application rules. Administrator can choose to categorize a communication map into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - communication_entries (
listofCommunicationEntryorNone) – CommunicationEntries that are a part of this CommunicationMap - precedence (
longorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.EdgeCommunicationMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Edge Communication map
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofCommunicationMap) – CommunicationMap list results
- links (
-
class
com.vmware.nsx_policy.model_client.EdgeHighAvailabilityProfile(bfd_allowed_hops=None, bfd_declare_dead_multiple=None, bfd_probe_interval=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EdgeHighAvailabilityProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProfile for BFD HA cluster setting
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bfd_allowed_hops (
longorNone) – BFD allowed hops format: int64 - bfd_declare_dead_multiple (
longorNone) – Number of times a packet is missed before BFD declares the neighbor down. format: int64 - bfd_probe_interval (
longorNone) – the time interval (in millisec) between probe packets for heartbeat purpose format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
ClusterProfile.RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILESupported cluster profiles.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- bfd_allowed_hops (
-
class
com.vmware.nsx_policy.model_client.EdgeNode(allocation_list=None, deployment_config=None, deployment_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EdgeNode', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocation_list (
listofstrorNone) – List of logical router ids to which this edge node is allocated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - deployment_config (
EdgeNodeDeploymentConfigorNone) – When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE will be deployed and registered with MP. - deployment_type (
strorNone) –Possible values are:
EdgeNode.DEPLOYMENT_TYPE_VIRTUAL_MACHINEEdgeNode.DEPLOYMENT_TYPE_PHYSICAL_MACHINEEdgeNode.DEPLOYMENT_TYPE_UNKNOWN
Supported edge deployment type.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or ‘PublicCloudGatewayNode’ - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - discovered_ip_addresses (
listofstrorNone) – Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – ID of the Node maintained on the Node and used to recognize the Node - fqdn (
strorNone) – Fully qualified domain name of the fabric node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
-
DEPLOYMENT_TYPE_PHYSICAL_MACHINE= 'PHYSICAL_MACHINE'¶
-
DEPLOYMENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
DEPLOYMENT_TYPE_VIRTUAL_MACHINE= 'VIRTUAL_MACHINE'¶
- allocation_list (
-
class
com.vmware.nsx_policy.model_client.EdgeNodeDeploymentConfig(form_factor=None, node_user_settings=None, vm_deployment_config=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - form_factor (
strorNone) –Possible values are:
EdgeNodeDeploymentConfig.FORM_FACTOR_SMALLEdgeNodeDeploymentConfig.FORM_FACTOR_MEDIUMEdgeNodeDeploymentConfig.FORM_FACTOR_LARGE
Supported edge form factor. - node_user_settings (
NodeUserSettings) – Username and password settings for the node. Note - these settings will be honored only during node deployment. Post deployment, CLI must be used for changing the user settings, changes to these parameters will not have any effect. - vm_deployment_config (
vmware.vapi.struct.VapiStruct) – When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inDeploymentConfig. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inDeploymentConfig.
-
FORM_FACTOR_LARGE= 'LARGE'¶
-
FORM_FACTOR_MEDIUM= 'MEDIUM'¶
-
FORM_FACTOR_SMALL= 'SMALL'¶
- form_factor (
-
class
com.vmware.nsx_policy.model_client.EdgeNodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEdge node element extends from Element class. This class contains the information of Edge.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofServiceElementorNone) – Array of service elements - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
EdgeNodeElement.RESOURCE_TYPE_VMELEMENTEdgeNodeElement.RESOURCE_TYPE_GROUPELEMENTEdgeNodeElement.RESOURCE_TYPE_PROCESSELEMENTEdgeNodeElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTEdgeNodeElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTEdgeNodeElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTEdgeNodeElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTEdgeNodeElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTEdgeNodeElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTEdgeNodeElement.RESOURCE_TYPE_HOSTNODEELEMENTEdgeNodeElement.RESOURCE_TYPE_EDGENODEELEMENTEdgeNodeElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTEdgeNodeElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element - fqdn (
strorNone) – Fully qualified domain name of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os (
strorNone) – Operating system type and version of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.EffectiveIPAddressMemberListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofstr) – Paged Collection of effective ip addresses for the given NSGroup format: address-or-block-or-range
- links (
-
class
com.vmware.nsx_policy.model_client.EffectiveMemberResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofResourceReference) – Paged Collection of resources which are the effective members of an NSGroup.
- links (
-
class
com.vmware.nsx_policy.model_client.EgressRateShaper(enabled=None, resource_type=None, average_bandwidth_mbps=None, burst_size_bytes=None, peak_bandwidth_mbps=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA shaper that specifies egress rate properties in Mb/s
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – - resource_type (
strorNone) –Possible values are:
- average_bandwidth_mbps (
longorNone) – Average bandwidth in Mb/s format: int32 - burst_size_bytes (
longorNone) – Burst size in bytes format: int32 - peak_bandwidth_mbps (
longorNone) – Peak bandwidth in Mb/s format: int32
-
RESOURCE_TYPE_EGRESSRATESHAPER= 'EgressRateShaper'¶
-
RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER= 'IngressBroadcastRateShaper'¶
-
RESOURCE_TYPE_INGRESSRATESHAPER= 'IngressRateShaper'¶
- enabled (
-
class
com.vmware.nsx_policy.model_client.Element(element_id=None, elements=None, resource_name=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base class of the realized element. Element can be VM, Group, Process, LogicalSwitch, LogicalT0Router, LogicalT1Router element.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
Element.RESOURCE_TYPE_VMELEMENTElement.RESOURCE_TYPE_GROUPELEMENTElement.RESOURCE_TYPE_PROCESSELEMENTElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTElement.RESOURCE_TYPE_HOSTNODEELEMENTElement.RESOURCE_TYPE_EDGENODEELEMENTElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.EmbeddedResource(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase class for resources that are embedded in other resources
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource.
- links (
-
class
com.vmware.nsx_policy.model_client.Endpoint(default_gateway=None, device_name=None, ip=None, label=None, mac=None, subnet_mask=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn Endpoint object is part of HostSwitch configuration in TransportNode
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - default_gateway (
strorNone) – Gateway IP format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - device_name (
strorNone) – Name of the virtual tunnel endpoint This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip (
strorNone) – Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - label (
longorNone) – Unique label for this Endpoint format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnet_mask (
strorNone) – Subnet mask format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- default_gateway (
-
class
com.vmware.nsx_policy.model_client.EnforcementPoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, connection_info=None, version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents endpoint where policy will be applied
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - connection_info (
vmware.vapi.struct.VapiStruct) – Enforcement point connection info When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inEnforcementPointConnectionInfo. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inEnforcementPointConnectionInfo. - version (
strorNone) – Version of the Enforcement point This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.EnforcementPointConnectionInfo(enforcement_point_address=None, resource_type='EnforcementPointConnectionInfo')¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains information required to connect to enforcement point
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enforcement_point_address (
strorNone) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be "10.192.1.1", for NSX-T manager running on custom port value can be "192.168.1.1:32789". For NSX-T manager in VMC deployments value can have url prefix eg. "192.168.1.1:5480/nsxapi" - resource_type (
str) –Possible values are:
-
RESOURCE_TYPE_NSXTCONNECTIONINFO= 'NSXTConnectionInfo'¶
-
RESOURCE_TYPE_NSXVCONNECTIONINFO= 'NSXVConnectionInfo'¶
- enforcement_point_address (
-
class
com.vmware.nsx_policy.model_client.EnforcementPointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of enforcement points
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofEnforcementPoint) – EnforcementPoint list results
- links (
-
class
com.vmware.nsx_policy.model_client.EntityInstanceCountConstraintExpression(count=None, operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EntityInstanceCountConstraintExpression', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the leaf level constraint to restrict the number instances of an entity type can be created. This is useful in restricting number of CGWs or MGWs or Providers that can created in a system.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - count (
long) – Instance count. format: int64 - operator (
str) – Operations supported ‘<’ and ‘<=’. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- count (
-
class
com.vmware.nsx_policy.model_client.ErrorResolverInfo(error_id=None, resolver_present=None, user_metadata=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMetadata related to a given error_id
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - error_id (
long) – The error id for which metadata information is needed format: int64 - resolver_present (
bool) – Indicates whether there is a resolver associated with the error or not - user_metadata (
ErrorResolverUserMetadataorNone) – User supplied metadata that might be required by the resolver
- error_id (
-
class
com.vmware.nsx_policy.model_client.ErrorResolverInfoList(results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of all registered ErrorResolverInfo
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: results ( listofErrorResolverInfo) – ErrorResolverInfo list
-
class
com.vmware.nsx_policy.model_client.ErrorResolverMetadata(entity_id=None, error_id=None, system_metadata=None, user_metadata=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructError along with its metadata
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - entity_id (
str) – The entity/node UUID where the error has occurred. - error_id (
long) – The error id as reported by the entity where the error occurred. format: int64 - system_metadata (
ErrorResolverSystemMetadataorNone) – This can come from some external system like syslog collector - user_metadata (
ErrorResolverUserMetadataorNone) – User supplied metadata that might be required by the resolver
- entity_id (
-
class
com.vmware.nsx_policy.model_client.ErrorResolverMetadataList(errors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of errors with their metadata
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: errors ( listofErrorResolverMetadata) – List of errors with their corresponding metadata.
-
class
com.vmware.nsx_policy.model_client.ErrorResolverSystemMetadata(value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMetadata fetched from an external system like Syslog or LogInsight.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: value ( strorNone) – The value fetched from another system
-
class
com.vmware.nsx_policy.model_client.ErrorResolverUserInputData(data_type=None, property_name=None, property_value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCorresponds to one property entered by the user
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - data_type (
str) –Possible values are:
ErrorResolverUserInputData.DATA_TYPE_TEXTErrorResolverUserInputData.DATA_TYPE_NUMBERErrorResolverUserInputData.DATA_TYPE_PASSWORD
The datatype of the given property. Useful for data validation - property_name (
str) – Name of the property supplied by the user - property_value (
strorNone) – The value associated with the above property
-
DATA_TYPE_NUMBER= 'NUMBER'¶
-
DATA_TYPE_PASSWORD= 'PASSWORD'¶
-
DATA_TYPE_TEXT= 'TEXT'¶
- data_type (
-
class
com.vmware.nsx_policy.model_client.ErrorResolverUserMetadata(user_input_list=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUser supplied metadata needed for resolving errors
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: user_input_list ( listofErrorResolverUserInputDataorNone) – List of user supplied input data.
-
class
com.vmware.nsx_policy.model_client.EtherTypeNSService(ether_type=None, resource_type='EtherTypeNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn NSService element that represents an ethertype protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ether_type (
long) – Type of the encapsulated protocol format: int64 - resource_type (
str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
- ether_type (
-
class
com.vmware.nsx_policy.model_client.EtherTypeServiceEntry(ether_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='EtherTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceEntry that represents an ethertype protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ether_type (
long) – Type of the encapsulated protocol format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ether_type (
-
class
com.vmware.nsx_policy.model_client.ExcludeList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, members=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - members (
listofResourceReference) – List of the members in the exclude list
- links (
-
class
com.vmware.nsx_policy.model_client.Expression(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Expression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAll the nodes of the expression extend from this abstract class. This is present for extensibility.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_CONDITION= 'Condition'¶
-
RESOURCE_TYPE_CONJUNCTIONOPERATOR= 'ConjunctionOperator'¶
-
RESOURCE_TYPE_IPADDRESSEXPRESSION= 'IPAddressExpression'¶
-
RESOURCE_TYPE_NESTEDEXPRESSION= 'NestedExpression'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ExtraConfig(config_pair=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructExtra config is intended for supporting vendor specific configuration on the data path, it can be set as key value string pairs on either logical switch or logical port. If it was set on logical switch, it will be inherited automatically by logical ports in it. Also logical port setting will override logical switch setting if specific key was dual set on both logical switch and logical port.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: config_pair ( KeyValuePair) – Key value pair in string for the configuration
-
class
com.vmware.nsx_policy.model_client.ExtraConfigHostSwitchProfile(extra_configs=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ExtraConfigHostSwitchProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProfile for extra configs in host switch
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - extra_configs (
listofExtraConfigorNone) – list of extra configs - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- extra_configs (
-
class
com.vmware.nsx_policy.model_client.FabricModule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, current_version=None, custom_data=None, deployment_specs=None, fabric_module_name=None, source_authentication_mode=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFabric module contains list of deployment specs and current version. Each deployment spec is a different version of same fabric module. If fabric module have two deployment specs or say two different versions then current version will specify which version needs to be installed.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - current_version (
str) – current version on for the host prep fabric module. - custom_data (
listofStringMapEntryorNone) – Slot for storing consumer data (fabric module’s specific data common across all the realizations of the fabric module) - deployment_specs (
listofDeploymentSpec) – List of deployment specs - fabric_module_name (
str) – Name of the fabric module - source_authentication_mode (
strorNone) –Possible values are:
FabricModule.SOURCE_AUTHENTICATION_MODE_NO_AUTHENTICATIONFabricModule.SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATIONFabricModule.SOURCE_AUTHENTICATION_MODE_MARKET_PLACE
This enum specifies the authentication supported at source i.e. for downloading VM. If this attribute is not provided, then NO_AUTHENTICATION will be considered.
-
SOURCE_AUTHENTICATION_MODE_BASIC_AUTHENTICATION= 'BASIC_AUTHENTICATION'¶
-
SOURCE_AUTHENTICATION_MODE_MARKET_PLACE= 'MARKET_PLACE'¶
-
SOURCE_AUTHENTICATION_MODE_NO_AUTHENTICATION= 'NO_AUTHENTICATION'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FabricModuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFabric Module list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFabricModuleorNone) – Fabric Module list results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureAccess(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, feature=None, information=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFeature access
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Feature enabled or not This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - feature (
strorNone) – Feature This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - information (
listofFeatureInfoorNone) – Feature Info
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureAccessListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFeatureAccess) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureInfo(info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFeature Info
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: info ( strorNone) – Info This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
class
com.vmware.nsx_policy.model_client.FeaturePermission(feature=None, permission=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFeature Permission
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - feature (
strorNone) – Feature Name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - permission (
strorNone) –Possible values are:
FeaturePermission.PERMISSION_CRUDFeaturePermission.PERMISSION_READFeaturePermission.PERMISSION_EXECUTEFeaturePermission.PERMISSION_NONE
PermissionThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
PERMISSION_CRUD= 'crud'¶
-
PERMISSION_EXECUTE= 'execute'¶
-
PERMISSION_NONE= 'none'¶
-
PERMISSION_READ= 'read'¶
- feature (
-
class
com.vmware.nsx_policy.model_client.FeaturePermissionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFeaturePermission) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureStackCollectionConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, client_type_collection_configurations=None, feature_stack_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHPM feature stack data collection frequency configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - client_type_collection_configurations (
listofClientTypeCollectionConfigurationorNone) – The set of client type data collection configurations - feature_stack_name (
str) – The name of the feature stack
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureStackCollectionConfigurationList(results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFeature stack collection configuration list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: results ( listofFeatureStackCollectionConfigurationorNone) – The complete set of feature stack data collection configurations This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
class
com.vmware.nsx_policy.model_client.FeatureUsage(links=None, schema=None, self_=None, capacity_usage=None, feature=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructfeature usage result item
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - capacity_usage (
listofCapacityUsageorNone) – Capacity Usage List This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - feature (
strorNone) – name of the feature This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureUsageCsvRecord(cpu_usage_count=None, feature=None, vcpu_usage_count=None, vm_usage_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cpu_usage_count (
longorNone) – count of number of cpu sockets used by this feature format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - feature (
strorNone) – name of the feature This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vcpu_usage_count (
longorNone) – count of number of vcpus of public cloud VMs format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_usage_count (
longorNone) – count of number of vms used by this feature format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- cpu_usage_count (
-
class
com.vmware.nsx_policy.model_client.FeatureUsageList(links=None, schema=None, self_=None, feature_usage_info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructlist of feature usage items
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - feature_usage_info (
listofFeatureUsageorNone) – Feature Usage List This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FeatureUsageListInCsvFormat(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFeatureUsageCsvRecordorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.FieldSanityConstraintExpression(checks=None, operator=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='FieldSanityConstraintExpression', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the field value constraint to constrain specified field value based on defined sanity checks. Example - For DNS.upstream_servers, all the IP addresses must either be public or private. { "target": { "target_resource_type": "DnsForwarderZone", "attribute": "upstreamServers", "path_prefix": "/infra/dns-forwarder-zones/" }, "constraint_expression": { "resource_type": "FieldSanityConstraintExpression", "operator": "OR", "checks": ["ALL_PUBLIC_IPS", "ALL_PRIVATE_IPS"] } }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - checks (
listofstr) –Possible values are:
FieldSanityConstraintExpression.CHECKS_PUBLIC_IPSFieldSanityConstraintExpression.CHECKS_PRIVATE_IPS
List of sanity checks. - operator (
str) –Possible values are:
A conditional operator - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
CHECKS_PRIVATE_IPS= 'ALL_PRIVATE_IPS'¶
-
CHECKS_PUBLIC_IPS= 'ALL_PUBLIC_IPS'¶
-
OPERATOR_AND= 'AND'¶
-
OPERATOR_OR= 'OR'¶
- checks (
-
class
com.vmware.nsx_policy.model_client.FileTransferAuthenticationScheme(password=None, scheme_name=None, username=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRemote server authentication details
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - password (
strorNone) – Password to authenticate with - scheme_name (
str) –Possible values are:
Authentication scheme name - username (
str) – User name to authenticate with
-
SCHEME_NAME_PASSWORD= 'PASSWORD'¶
- password (
-
class
com.vmware.nsx_policy.model_client.FileTransferProtocol(authentication_scheme=None, protocol_name=None, ssh_fingerprint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProtocol to transfer backup file to remote server
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - authentication_scheme (
FileTransferAuthenticationScheme) – Scheme to authenticate if required - protocol_name (
str) –Possible values are:
Protocol name - ssh_fingerprint (
str) – The expected SSH fingerprint of the server. If the server’s fingerprint does not match this fingerprint, the connection will be terminated. Only ECDSA fingerprints hashed with SHA256 are supported. To obtain the host’s ssh fingerprint, you should connect via some method other than SSH to obtain this information. You can use one of these commands to view the key’s fingerprint: 1. ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub 2. awk ‘{print $2}’ ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b | sed ‘s/ .\*$//’ | xxd -r -p | base64 | sed ‘s/.//44g’ | awk ‘{print "SHA256:"$1}’
-
PROTOCOL_NAME_SFTP= 'sftp'¶
- authentication_scheme (
-
class
com.vmware.nsx_policy.model_client.FilterRequest(field_names=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFilter request parameters
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - field_names (
str) – Comma seperated fields to be filtered on - value (
str) – Filter value
- field_names (
-
class
com.vmware.nsx_policy.model_client.FireWallServiceAssociationListResult(results=None, links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='FireWallServiceAssociationListResult')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - results (
listofFirewallRuleorNone) – Firewall rule list result with pagination support. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_type (
str) –Possible values are:
- results (
-
class
com.vmware.nsx_policy.model_client.FirewallRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None, section_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - action (
str) –Possible values are:
FirewallRule.ACTION_ALLOWFirewallRule.ACTION_DROPFirewallRule.ACTION_REJECTFirewallRule.ACTION_REDIRECTFirewallRule.ACTION_DO_NOT_REDIRECT
Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP - Drop any packet when a rule with this action gets a match. Packets won’t go further(Used by Firewall). REJECT - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion).
- applied_tos (
listofResourceReferenceorNone) – List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any. - destinations (
listofResourceReferenceorNone) – List of the destinations. Null will be treated as any. - destinations_excluded (
boolorNone) – Negation of the destination. - direction (
strorNone) –Possible values are:
Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.
- disabled (
boolorNone) – Flag to disable rule. Disabled will only be persisted but never provisioned/realized. - ip_protocol (
strorNone) –Possible values are:
Type of IP packet that should be matched while enforcing the rule. - is_default (
boolorNone) – Flag to indicate whether rule is default. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - notes (
strorNone) – User notes specific to the rule. - rule_tag (
strorNone) – User level field which will be printed in CLI and packet logs. - services (
listofFirewallServiceorNone) – List of the services. Null will be treated as any. - sources (
listofResourceReferenceorNone) – List of sources. Null will be treated as any. - sources_excluded (
boolorNone) – Negation of the source. - section_id (
strorNone) – Section Id of the section to which this rule belongs to. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DO_NOT_REDIRECT= 'DO_NOT_REDIRECT'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REDIRECT= 'REDIRECT'¶
-
ACTION_REJECT= 'REJECT'¶
-
DIRECTION_IN= 'IN'¶
-
DIRECTION_IN_OUT= 'IN_OUT'¶
-
DIRECTION_OUT= 'OUT'¶
-
IP_PROTOCOL_IPV4= 'IPV4'¶
-
IP_PROTOCOL_IPV4_IPV6= 'IPV4_IPV6'¶
-
IP_PROTOCOL_IPV6= 'IPV6'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFirewallRuleorNone) – Firewall rule list result with pagination support. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo. - is_default (
boolorNone) – It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
str) –Possible values are:
FirewallSection.SECTION_TYPE_LAYER2FirewallSection.SECTION_TYPE_LAYER3FirewallSection.SECTION_TYPE_L3REDIRECT
Type of the rules which a section can contain. Only homogeneous sections are supported.
- stateful (
bool) – Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless. - autoplumbed (
boolorNone) – This flag indicates whether it is an auto-plumbed section that is associated to a LogicalRouter. Auto-plumbed sections are system owned and cannot be updated via the API. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - comments (
strorNone) – Comments for section lock/unlock. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforced_on (
strorNone) – This attribute represents enforcement point of firewall section. For example, firewall section enforced on logical port with attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, firewall section enforced on logical router will have ‘LOGICALROUTER’ value and rest have ‘VIF’ value. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lock_modified_by (
strorNone) – ID of the user who last modified the lock for the section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lock_modified_time (
longorNone) – Section locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - locked (
boolorNone) – Section is locked/unlocked. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SECTION_TYPE_L3REDIRECT= 'L3REDIRECT'¶
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFirewallSectionorNone) – List of the firewall sections. The list has to be homogenous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, autoplumbed=None, comments=None, enforced_on=None, lock_modified_by=None, lock_modified_time=None, locked=None, rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo. - is_default (
boolorNone) – It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
str) –Possible values are:
FirewallSectionRuleList.SECTION_TYPE_LAYER2FirewallSectionRuleList.SECTION_TYPE_LAYER3FirewallSectionRuleList.SECTION_TYPE_L3REDIRECT
Type of the rules which a section can contain. Only homogeneous sections are supported.
- stateful (
bool) – Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless. - autoplumbed (
boolorNone) – This flag indicates whether it is an auto-plumbed section that is associated to a LogicalRouter. Auto-plumbed sections are system owned and cannot be updated via the API. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - comments (
strorNone) – Comments for section lock/unlock. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforced_on (
strorNone) – This attribute represents enforcement point of firewall section. For example, firewall section enforced on logical port with attachment type bridge endpoint will have ‘BRIDGEENDPOINT’ value, firewall section enforced on logical router will have ‘LOGICALROUTER’ value and rest have ‘VIF’ value. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lock_modified_by (
strorNone) – ID of the user who last modified the lock for the section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lock_modified_time (
longorNone) – Section locked/unlocked time in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - locked (
boolorNone) – Section is locked/unlocked. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rules (
listofFirewallRule) – List of firewall rules in the section. Only homogenous rules are supported.
-
SECTION_TYPE_L3REDIRECT= 'L3REDIRECT'¶
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallSectionState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
FirewallSectionState.STATE_PENDINGFirewallSectionState.STATE_IN_PROGRESSFirewallSectionState.STATE_SUCCESSFirewallSectionState.STATE_FAILEDFirewallSectionState.STATE_PARTIAL_SUCCESSFirewallSectionState.STATE_ORPHANEDFirewallSectionState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- revision_desired (
longorNone) – revision number of the desired state format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.FirewallSectionsSummary(links=None, schema=None, self_=None, rule_count=None, section_count=None, section_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - rule_count (
longorNone) – Total number of rules in the section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_count (
longorNone) – Total number of sections for the section type. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
strorNone) –Possible values are:
Type of rules which a section can contain.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SECTION_TYPE_L2DFW= 'L2DFW'¶
-
SECTION_TYPE_L3DFW= 'L3DFW'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - service (
vmware.vapi.struct.VapiStructorNone) – Distributed Service API accepts raw protocol and ports as part of NS service element in Distributed Service Rule that describes traffic corresponding to an NSService. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.FirewallStats(links=None, schema=None, self_=None, byte_count=None, max_popularity_index=None, max_session_count=None, packet_count=None, popularity_index=None, rule_id=None, session_count=None, total_session_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - byte_count (
longorNone) – Aggregated number of bytes processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - max_popularity_index (
longorNone) – Maximum value of popularity index of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - max_session_count (
longorNone) – Maximum value of sessions count of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packet_count (
longorNone) – Aggregated number of packets processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - popularity_index (
longorNone) – This is calculated by sessions count divided by age of the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_id (
strorNone) – Rule Identifier of the Firewall rule. This is a globally unique number. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - session_count (
longorNone) – Aggregated number of sessions processed by the rule. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total_session_count (
longorNone) – Aggregated number of sessions processed by the all firewall rules. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallStatus(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, context=None, global_status=None, target_statuses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFirewall Status Response
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - context (
str) –Possible values are:
Types of firewall contexts. - global_status (
str) –Possible values are:
Firewall status for a fabric entity or in global context where firewall is supported.
- target_statuses (
listofTargetResourceStatusorNone) – List of firewall status on various target logical resources. This will override the global status of corresponding firewall context (e.g it will override the gloabal status of logical_routers).
-
CONTEXT_LOGICAL_ROUTERS= 'logical_routers'¶
-
CONTEXT_TRANSPORT_NODES= 'transport_nodes'¶
-
GLOBAL_STATUS_DISABLED= 'DISABLED'¶
-
GLOBAL_STATUS_ENABLED= 'ENABLED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.FirewallStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of firewall statuses for a context or all context
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofFirewallStatusorNone) –
- links (
Bases:
vmware.vapi.bindings.struct.VapiStructFooter of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - actions (
listofFooterActionorNone) – Action to be performed at the footer of a widget. An action at the footer can be simple text description or a hyperlink to a UI page. Action allows a clickable url for navigation. An example usage of footer action is provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - condition (
strorNone) – If the condition is met then the footer will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
- actions (
Bases:
vmware.vapi.bindings.struct.VapiStructAction specified at the footer of a widget to provide additional information or to provide a clickable url for navigation. An example usage of footer action is provided under the ‘example_request’ section of ‘CreateWidgetConfiguration’ API.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dock_to_container_footer (
boolorNone) – If true, the footer will appear in the underlying container that holds the widget. - label (
Label) – Label to be displayed against the footer action. - url (
strorNone) – Hyperlink to the UI page that provides details of action.
- dock_to_container_footer (
-
class
com.vmware.nsx_policy.model_client.ForwarderZone(source_ip=None, upstream_servers=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - source_ip (
strorNone) – The source ip used by the fowarder of the zone. If no source ip specified, the ip address of listener of the dns forwarder will be used. format: ipv4 - upstream_servers (
listofstr) – Ip address of the upstream dns servers the dns forwarder accesses. format: ipv4
- source_ip (
-
class
com.vmware.nsx_policy.model_client.GatewayPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains ordered list of Rules for GatewayPolicy
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - category (
strorNone) – Policy framework provides four pre-defined categories for classifying a security policy. They are "Emergency", "Infrastructure" "Environmental" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Emergency category has the highest priority followed by Infrastructure, Environmental and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - rules (
listofRuleorNone) – Rules that are a part of this SecurityPolicy - sequence_number (
longorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.GatewayPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of gateway policies
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofSecurityPolicy) – SecurityPolicy list results
- links (
-
class
com.vmware.nsx_policy.model_client.GenericDhcpOption(code=None, values=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - code (
long) – dhcp option code, [0-255] format: int64 - values (
listofstr) – dhcp option value
- code (
-
class
com.vmware.nsx_policy.model_client.GenericPolicyRealizedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, entity_type=None, extended_attributes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents realized entity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
GenericPolicyRealizedResource.STATE_UNAVAILABLEGenericPolicyRealizedResource.STATE_UNREALIZEDGenericPolicyRealizedResource.STATE_REALIZEDGenericPolicyRealizedResource.STATE_ERROR
Realization state of this object - entity_type (
strorNone) – Type of realized entity This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - extended_attributes (
listofAttributeValorNone) – Collection of type specific properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.GenericPolicyRealizedResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructGenericPolicyRealizedResource list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofGenericPolicyRealizedResourceorNone) – List of realized resources
- links (
-
class
com.vmware.nsx_policy.model_client.GlobalCollectionConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, aggregated_data_collection_frequency=None, is_data_collection_enabled=None, modified_feature_stack_collection_configurations=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - aggregated_data_collection_frequency (
long) – The frequency in seconds at which data, which is subject to the aggregation function, is collected. format: int64 - is_data_collection_enabled (
bool) – Indicates whether data collection required by the aggregation service is enabled. If false, no aggregation service data will be collected. Changing this property will not affect the existing data collection frequency settings. - modified_feature_stack_collection_configurations (
FeatureStackCollectionConfigurationListorNone) – The list of the locally modified feature stack data collection frequency settings. If all feature stack data collection configurations are set to their default values, this list will be empty.
- links (
-
class
com.vmware.nsx_policy.model_client.GlobalRestoreStatus(description=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructOverall restore process status
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - description (
strorNone) – A description of the restore status This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - value (
strorNone) –Possible values are:
GlobalRestoreStatus.VALUE_NOT_AVAILABLEGlobalRestoreStatus.VALUE_NOT_STARTEDGlobalRestoreStatus.VALUE_SUCCESSGlobalRestoreStatus.VALUE_ERRORGlobalRestoreStatus.VALUE_RUNNINGGlobalRestoreStatus.VALUE_SUSPENDINGGlobalRestoreStatus.VALUE_SUSPENDEDGlobalRestoreStatus.VALUE_ABORTED
Global rolled-up restore status valueThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
VALUE_ABORTED= 'ABORTED'¶
-
VALUE_ERROR= 'ERROR'¶
-
VALUE_NOT_AVAILABLE= 'NOT_AVAILABLE'¶
-
VALUE_NOT_STARTED= 'NOT_STARTED'¶
-
VALUE_RUNNING= 'RUNNING'¶
-
VALUE_SUCCESS= 'SUCCESS'¶
-
VALUE_SUSPENDED= 'SUSPENDED'¶
-
VALUE_SUSPENDING= 'SUSPENDING'¶
- description (
-
class
com.vmware.nsx_policy.model_client.GridConfiguration(columns=None, page_size=None, row_list_fields=None, span=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='GridConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents configuration of a Grid or Table widget.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - columns (
listofColumnItem) – Array of columns of a Grid widget - page_size (
longorNone) – Number of records per page. page_size will be effective only when the urls provided in the datasource support paging. format: int32 - row_list_fields (
listofRowListField) – Rows of grid or table are formed from the list of objects returned by a row list field. - span (
longorNone) – Represents the horizontal span of the Grid. format: int32 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- columns (
-
class
com.vmware.nsx_policy.model_client.Group(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, expression=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - expression (
listofvmware.vapi.struct.VapiStructorNone) – The expression list must follow below criteria: 1. A non-empty expression list, must be of odd size. In a list, with indices starting from 0, all conjunction expressions must be at odd indices, and all non-conjunction expressions must be at even indices. 2. There may be at most 5 non-conjunction expressions in a list. 3. All non-conjunction expressions must be of the same type, and must be Condition expressions or IPAddress expressions. 4. For IPAddressExpression nodes, OR is the only conjunction operator allowed. 5. For ConditionExpression, both OR and AND operators are allowed, but there must not be two consecutive AND operators. 6. All Condition expressions must have same member type. 7. Each expression must be a valid Expression. See the definition of the Expression type for more information. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inExpression. - state (
strorNone) –Possible values are:
Realization state of this group
-
STATE_FAILURE= 'FAILURE'¶
-
STATE_IN_PROGRESS= 'IN_PROGRESS'¶
-
STATE_SUCCESS= 'SUCCESS'¶
- links (
-
class
com.vmware.nsx_policy.model_client.GroupConnection(dest_element_id=None, number_of_events=None, src_element_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructGroupConnection contains the statistic information of the connection between two groups.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_element_id (
strorNone) – Unique element ID of destination element to which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - number_of_events (
longorNone) – Represents the number of events/flows between the source and destination elements. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_element_id (
strorNone) – Unique element ID of source element from which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- dest_element_id (
-
class
com.vmware.nsx_policy.model_client.GroupElement(element_id=None, elements=None, resource_name=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructGroup element extends from Element class. This class contains the information related to the group.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.GroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Groups
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofGroup) – Group list results
- links (
-
class
com.vmware.nsx_policy.model_client.HaVipConfig(enabled=None, ha_vip_subnets=None, redundant_uplink_port_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
boolorNone) – Flag to enable this ha vip config. - ha_vip_subnets (
listofVIPSubnet) – Array of IP address subnets which will be used as floating IP addresses. | Note - this configuration is applicable only for Active-Standby LogicalRouter. | For Active-Active LogicalRouter this configuration will be rejected. - redundant_uplink_port_ids (
listofstr) – Identifiers of logical router uplink ports which are to be paired to provide | redundancy. Floating IP will be owned by one of these uplink ports (depending upon | which node is Active).
- enabled (
-
class
com.vmware.nsx_policy.model_client.HostAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host=None, status=None, transport_node=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAggregation of desired and runtime status of host
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - host (
HostNodeorNone) – Host attributes - status (
NodeStatusorNone) – Host status - transport_node (
TransportNodeorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.HostAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost aggregate state list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofHostAggregateInfo) – Host Aggregate Info Results
- links (
-
class
com.vmware.nsx_policy.model_client.HostInfraTrafficType(dynamic_res_pool_name=None, traffic_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe traffic_name specifies the infrastructure traffic type and it must be one of the following system-defined types: FAULT_TOLERANCE is traffic for failover and recovery. HBR is traffic for Host based replication. ISCSI is traffic for Internet Small Computer System Interface. MANAGEMENT is traffic for host management. NFS is traffic related to file transfer in network file system. VDP is traffic for vSphere data protection. VIRTUAL_MACHINE is traffic generated by virtual machines. VMOTION is traffic for computing resource migration. VSAN is traffic generated by virtual storage area network. The dynamic_res_pool_name provides a name for the resource pool. It can be any arbitrary string. Either traffic_name or dynamic_res_pool_name must be set. If both are specified or omitted, an error will be returned.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dynamic_res_pool_name (
strorNone) – Dynamic resource pool traffic name - traffic_name (
strorNone) –Possible values are:
HostInfraTrafficType.TRAFFIC_NAME_FAULT_TOLERANCEHostInfraTrafficType.TRAFFIC_NAME_HBRHostInfraTrafficType.TRAFFIC_NAME_ISCSIHostInfraTrafficType.TRAFFIC_NAME_MANAGEMENTHostInfraTrafficType.TRAFFIC_NAME_NFSHostInfraTrafficType.TRAFFIC_NAME_VDPHostInfraTrafficType.TRAFFIC_NAME_VIRTUAL_MACHINEHostInfraTrafficType.TRAFFIC_NAME_VMOTIONHostInfraTrafficType.TRAFFIC_NAME_VSAN
Traffic types
-
TRAFFIC_NAME_FAULT_TOLERANCE= 'FAULT_TOLERANCE'¶
-
TRAFFIC_NAME_HBR= 'HBR'¶
-
TRAFFIC_NAME_ISCSI= 'ISCSI'¶
-
TRAFFIC_NAME_MANAGEMENT= 'MANAGEMENT'¶
-
TRAFFIC_NAME_NFS= 'NFS'¶
-
TRAFFIC_NAME_VDP= 'VDP'¶
-
TRAFFIC_NAME_VIRTUAL_MACHINE= 'VIRTUAL_MACHINE'¶
-
TRAFFIC_NAME_VMOTION= 'VMOTION'¶
-
TRAFFIC_NAME_VSAN= 'VSAN'¶
- dynamic_res_pool_name (
-
class
com.vmware.nsx_policy.model_client.HostNode(discovered_node_id=None, host_credential=None, managed_by_server=None, os_type=None, os_version=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HostNode', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - discovered_node_id (
strorNone) – Id of the discovered node which was converted to create this node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_credential (
HostNodeLoginCredentialorNone) – Login credentials for the host - managed_by_server (
strorNone) – The id of the virtual center server managing the ESXi type HostNode. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os_type (
str) –Possible values are:
HostNode.OS_TYPE_ESXIHostNode.OS_TYPE_RHELKVMHostNode.OS_TYPE_UBUNTUKVMHostNode.OS_TYPE_HYPERVHostNode.OS_TYPE_RHELCONTAINERHostNode.OS_TYPE_RHELSERVERHostNode.OS_TYPE_UBUNTUSERVERHostNode.OS_TYPE_CENTOSSERVERHostNode.OS_TYPE_CENTOSKVM
Hypervisor type, for example ESXi or RHEL KVM. - os_version (
strorNone) – The version of the hypervisor operating system. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or ‘PublicCloudGatewayNode’ - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - discovered_ip_addresses (
listofstrorNone) – Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – ID of the Node maintained on the Node and used to recognize the Node - fqdn (
strorNone) – Fully qualified domain name of the fabric node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
-
OS_TYPE_CENTOSKVM= 'CENTOSKVM'¶
-
OS_TYPE_CENTOSSERVER= 'CENTOSSERVER'¶
-
OS_TYPE_ESXI= 'ESXI'¶
-
OS_TYPE_HYPERV= 'HYPERV'¶
-
OS_TYPE_RHELCONTAINER= 'RHELCONTAINER'¶
-
OS_TYPE_RHELKVM= 'RHELKVM'¶
-
OS_TYPE_RHELSERVER= 'RHELSERVER'¶
-
OS_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
-
OS_TYPE_UBUNTUSERVER= 'UBUNTUSERVER'¶
- discovered_node_id (
-
class
com.vmware.nsx_policy.model_client.HostNodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost node element extends from Element class. This class contains the information of Host.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
HostNodeElement.RESOURCE_TYPE_VMELEMENTHostNodeElement.RESOURCE_TYPE_GROUPELEMENTHostNodeElement.RESOURCE_TYPE_PROCESSELEMENTHostNodeElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTHostNodeElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTHostNodeElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTHostNodeElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTHostNodeElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTHostNodeElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTHostNodeElement.RESOURCE_TYPE_HOSTNODEELEMENTHostNodeElement.RESOURCE_TYPE_EDGENODEELEMENTHostNodeElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTHostNodeElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element - fqdn (
strorNone) – Fully qualified domain name of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os (
strorNone) – Operating system type and version of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.HostNodeLoginCredential(password=None, thumbprint=None, username=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe credentials to login into the host node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - password (
strorNone) – The authentication password of the host node - thumbprint (
strorNone) – For ESXi hosts, the thumbprint of the ESXi management service. For KVM hosts, the SSH key fingerprint. - username (
strorNone) – The username of the account on the host node
- password (
-
class
com.vmware.nsx_policy.model_client.HostProfileNetworkMigrationSpec(network_mappings=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='HostProfileNetworkMigrationSpec', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis specification should be used to define which VMK adapters need to be migrated to NSX logical switches from VC network switches. Migrations specified here should match with those from associated Host Profiles from VC. Mismatch will result in migration failures. This specification only supports migration vmkernal adapters to NSX logical switches.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - network_mappings (
listofVmkToLogicalSwitchMappingorNone) – Based on provided mappings, VMkernal adapters will be migrated to mentioned logical switch. Without mappings specification doesn’t make any sense, hence minium one mapping should be specified. Assuming some sane value of 10 maximum migrations which will be supported by any single specification. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Supported network migration specification types.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- network_mappings (
-
class
com.vmware.nsx_policy.model_client.HostSwitch(host_switch_name=None, host_switch_profile_ids=None, pnics=None, static_ip_pool_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost Switch specification
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - host_switch_name (
strorNone) – If this name is unset or empty then the default host switch name will be used. The name must be unique among all host switches specified in a given Transport Node; unset name, empty name and the default host switch name are considered the same in terms of uniqueness. - host_switch_profile_ids (
listofHostSwitchProfileTypeIdEntryorNone) – HostSwitch profiles bound to this HostSwitch. If a profile ID is not provided for any HostSwitchProfileType that is supported by the Transport Node, the corresponding default profile will be bound to the HostSwitch. - pnics (
listofPnicorNone) – Physical NICs connected to the host switch - static_ip_pool_id (
strorNone) – ID of configured Static IP Pool. If specified allocate IP for Endpoints from Pool. Else assume IP will be assigned for Endpoints from DHCP. This field is deprecated, use ip_assignment_spec field instead.
- host_switch_name (
-
class
com.vmware.nsx_policy.model_client.HostSwitchProfileTypeIdEntry(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
strorNone) –Possible values are:
- value (
str) – key value
-
KEY_EXTRACONFIGHOSTSWITCHPROFILE= 'ExtraConfigHostSwitchProfile'¶
-
KEY_LLDPHOSTSWITCHPROFILE= 'LldpHostSwitchProfile'¶
-
KEY_NIOCPROFILE= 'NiocProfile'¶
-
KEY_UPLINKHOSTSWITCHPROFILE= 'UplinkHostSwitchProfile'¶
- key (
-
class
com.vmware.nsx_policy.model_client.HostSwitchProfilesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHostSwitch Profile queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – HostSwitch Profile Results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inBaseHostSwitchProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inBaseHostSwitchProfile. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.HostSwitchSpec(resource_type='HostSwitchSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe HostSwitchSpec is the base class for standard and preconfigured host switch specifications.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
-
RESOURCE_TYPE_PRECONFIGUREDHOSTSWITCHSPEC= 'PreconfiguredHostSwitchSpec'¶
-
RESOURCE_TYPE_STANDARDHOSTSWITCHSPEC= 'StandardHostSwitchSpec'¶
-
-
class
com.vmware.nsx_policy.model_client.HostSwitchState(endpoints=None, host_switch_id=None, host_switch_name=None, transport_zone_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost Switch State
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - endpoints (
listofEndpointorNone) – List of virtual tunnel endpoints which are configured on this switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_switch_id (
strorNone) – External ID of the HostSwitch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_switch_name (
strorNone) – The name must be unique among all host switches specified in a given Transport Node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_zone_ids (
listofstrorNone) – List of Ids of TransportZones this HostSwitch belongs to This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- endpoints (
-
class
com.vmware.nsx_policy.model_client.ICMPTypeNSService(icmp_code=None, icmp_type=None, protocol=None, resource_type='ICMPTypeNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructA NSService that represents IPv4 or IPv6 ICMP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - icmp_code (
longorNone) – ICMP message code format: int64 - icmp_type (
longorNone) – ICMP message type format: int64 - protocol (
str) –Possible values are:
ICMP protocol type - resource_type (
str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
-
PROTOCOL_ICMPV4= 'ICMPv4'¶
-
PROTOCOL_ICMPV6= 'ICMPv6'¶
- icmp_code (
-
class
com.vmware.nsx_policy.model_client.ICMPTypeServiceEntry(icmp_code=None, icmp_type=None, protocol=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ICMPTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceEntry that represents IPv4 or IPv6 ICMP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - icmp_code (
longorNone) – ICMP message code format: int64 - icmp_type (
longorNone) – ICMP message type format: int64 - protocol (
str) –Possible values are:
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
PROTOCOL_ICMPV4= 'ICMPv4'¶
-
PROTOCOL_ICMPV6= 'ICMPv6'¶
- icmp_code (
-
class
com.vmware.nsx_policy.model_client.IGMPTypeNSService(resource_type='IGMPTypeNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructA NSService that represents IGMP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
-
class
com.vmware.nsx_policy.model_client.IGMPTypeServiceEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IGMPTypeServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceEntry that represents IGMP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.IPAddressExpression(ip_addresses=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPAddressExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents IP address expressions in the form of an array, to support addition of IP addresses in a group.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstr) – This array can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed. Supported list of formats are, "192.168.1.1", "192.168.1.1-192.168.1.100", "192.168.0.0/24", "fe80::250:56ff:fe83:318c", "fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c", "fe80::250:56ff:fe83:318c/64". format: address-or-block-or-range - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.IPFIXCollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipaddress=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX data will be collected on collector Host ip and port address should be provided for collector.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ipaddress (
str) – IP address for the IPFIX collector. format: ip - port (
long) – Port for the IPFIX collector. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXCollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of IPFIX collector profiles.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPFIXCollectorProfile) – IPFIX collector Instances list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXCollectorProfileUIResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipaddress=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX data will be collected on collector Host ip and port address should be provided for collector.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ipaddress (
str) – IP address for the IPFIX collector. format: ip - port (
long) – Port for the IPFIX collector. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXCollectorProfileUIResourceList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_collectors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of IPFIX Collectors
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ipfix_collectors (
listofIPFIXCollectorProfile) – IPFIX collector profiles
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXDFWCollector(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, collector_ip_address=None, collector_port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX DFW data will be collected on collector Host IP and Port address should be provided for collector.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - collector_ip_address (
str) – IP address for the IPFIX DFW collector. format: ip - collector_port (
long) – Port for the IPFIX DFW collector. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ipfix_dfw_collectors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX data for the NSX distributed firewall will be sent to the specified IPFIX collectors.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ipfix_dfw_collectors (
listofIPFIXDFWCollector) – It accepts Multiple Collectors.
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXDFWCollectorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of IPFIX DFW Collector Profile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPFIXDFWCollectorProfile) – IPFIX DFW Collection Instances list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXDFWProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_flow_export_timeout=None, ipfix_dfw_collector_profile_path=None, observation_domain_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX packets from source will be sent to IPFIX DFW collector.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - active_flow_export_timeout (
long) – For long standing active flows, IPFIX records will be sent per timeout period in seconds. format: int32 - ipfix_dfw_collector_profile_path (
str) – Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors. - observation_domain_id (
longorNone) – An identifier that is unique to the exporting process and used to meter the flows. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXDFWProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of IPFIX DFW Profile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPFIXDFWProfile) – IPFIX DFW Profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_timeout=None, idle_timeout=None, ipfix_collector_profile_paths=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None, source_logical_segment_paths=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX data from source logical segment will be copied to IPFIX collector.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - active_timeout (
long) – The time in seconds after a flow is expired even if more packets matching this flow are received by the cache. format: int32 - idle_timeout (
long) – The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache. format: int32 - ipfix_collector_profile_paths (
listofstr) – Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors. - max_flows (
longorNone) – The maximum number of flow entries in each exporter flow cache. format: int64 - observation_domain_id (
longorNone) – An identifier that is unique to the exporting process and used to meter the Flows. format: int32 - packet_sample_probability (
float) – The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet. - source_logical_segment_paths (
listofstr) – Policy path for source tier-1 segment. IPFIX data from these logical segments will be sent IPFIX collector.
- links (
-
class
com.vmware.nsx_policy.model_client.IPFIXSwitchCollectionInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of IPFIX Switch Collection Instances
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPFIXSwitchCollectionInstance) – IPFIX Switch Collection Instances list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPInfo(ip_addresses=None, prefix_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstr) – IPv4 Addresses format: ipv4 - prefix_length (
long) – Subnet Prefix Length format: int64
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.IPMirrorDestination(destination_ips=None, encapsulation_type=None, erspan_id=None, gre_key=None, resource_type='IPMirrorDestination')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - destination_ips (
listofstr) – The destination IPs of the mirror packet will be sent to. format: ip - encapsulation_type (
str) –Possible values are:
IPMirrorDestination.ENCAPSULATION_TYPE_GREIPMirrorDestination.ENCAPSULATION_TYPE_ERSPAN_TWOIPMirrorDestination.ENCAPSULATION_TYPE_ERSPAN_THREE
You can choose GRE, ERSPAN II or ERSPAN III. - erspan_id (
longorNone) – Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III. format: int32 - gre_key (
longorNone) – User-configurable 32-bit key only for GRE format: int32 - resource_type (
str) –Possible values are:
MirrorDestination.RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_PNICMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_IPMIRRORDESTINATION
Resource types of mirror destination
-
ENCAPSULATION_TYPE_ERSPAN_THREE= 'ERSPAN_THREE'¶
-
ENCAPSULATION_TYPE_ERSPAN_TWO= 'ERSPAN_TWO'¶
-
ENCAPSULATION_TYPE_GRE= 'GRE'¶
- destination_ips (
-
class
com.vmware.nsx_policy.model_client.IPPrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, prefixes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - prefixes (
listofPrefixConfig) – Ordered list of PrefixConfig
- links (
-
class
com.vmware.nsx_policy.model_client.IPPrefixListListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPPrefixList) – Paginated list of IPPrefixLists
- links (
-
class
com.vmware.nsx_policy.model_client.IPProtocolNSService(protocol_number=None, resource_type='IPProtocolNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn NSService element that represents an IP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - protocol_number (
long) – The IP protocol number format: int64 - resource_type (
str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
- protocol_number (
-
class
com.vmware.nsx_policy.model_client.IPProtocolServiceEntry(protocol_number=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPProtocolServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceEntry that represents an IP protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - protocol_number (
long) – - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- protocol_number (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNDPDProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dpd_probe_interval=None, enabled=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - dpd_probe_interval (
longorNone) – DPD probe interval defines a periodic interval for DPD probes. format: int64 - enabled (
boolorNone) – If true, enable dead peer detection.
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNDPDProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the dead peer detection (DPD) profiles.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNDPDProfile) – IPSec DPD Profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNIKEProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dh_groups=None, digest_algorithms=None, encryption_algorithms=None, ike_version=None, sa_life_time=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - dh_groups (
listofstrorNone) –Possible values are:
IPSecVPNIKEProfile.DH_GROUPS_GROUP2IPSecVPNIKEProfile.DH_GROUPS_GROUP5IPSecVPNIKEProfile.DH_GROUPS_GROUP14IPSecVPNIKEProfile.DH_GROUPS_GROUP15IPSecVPNIKEProfile.DH_GROUPS_GROUP16
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
- digest_algorithms (
listofstrorNone) –Possible values are:
IPSecVPNIKEProfile.DIGEST_ALGORITHMS_SHA1IPSecVPNIKEProfile.DIGEST_ALGORITHMS_SHA2_256IPSecVPNIKEProfile.DIGEST_ALGORITHMS_SHA2_384IPSecVPNIKEProfile.DIGEST_ALGORITHMS_SHA2_512
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.
- encryption_algorithms (
listofstrorNone) –Possible values are:
IPSecVPNIKEProfile.ENCRYPTION_ALGORITHMS__128IPSecVPNIKEProfile.ENCRYPTION_ALGORITHMS__256IPSecVPNIKEProfile.ENCRYPTION_ALGORITHMS_GCM_128IPSecVPNIKEProfile.ENCRYPTION_ALGORITHMS_GCM_192IPSecVPNIKEProfile.ENCRYPTION_ALGORITHMS_GCM_256
Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.
- ike_version (
strorNone) –Possible values are:
IPSecVPNIKEProfile.IKE_VERSION_V1IPSecVPNIKEProfile.IKE_VERSION_V2IPSecVPNIKEProfile.IKE_VERSION_FLEX
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.
- sa_life_time (
longorNone) – Life time for security association. Default is 86400 seconds (1 day). format: int64
-
DH_GROUPS_GROUP14= 'GROUP14'¶
-
DH_GROUPS_GROUP15= 'GROUP15'¶
-
DH_GROUPS_GROUP16= 'GROUP16'¶
-
DH_GROUPS_GROUP2= 'GROUP2'¶
-
DH_GROUPS_GROUP5= 'GROUP5'¶
-
DIGEST_ALGORITHMS_SHA1= 'SHA1'¶
-
DIGEST_ALGORITHMS_SHA2_256= 'SHA2_256'¶
-
DIGEST_ALGORITHMS_SHA2_384= 'SHA2_384'¶
-
DIGEST_ALGORITHMS_SHA2_512= 'SHA2_512'¶
-
ENCRYPTION_ALGORITHMS_128= 'AES_128'¶
-
ENCRYPTION_ALGORITHMS_256= 'AES_256'¶
-
ENCRYPTION_ALGORITHMS_GCM_128= 'AES_GCM_128'¶
-
ENCRYPTION_ALGORITHMS_GCM_192= 'AES_GCM_192'¶
-
ENCRYPTION_ALGORITHMS_GCM_256= 'AES_GCM_256'¶
-
IKE_VERSION_FLEX= 'IKE_FLEX'¶
-
IKE_VERSION_V1= 'IKE_V1'¶
-
IKE_VERSION_V2= 'IKE_V2'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNIKEProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the IKE profiles.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNIKEProfile) – IKE Profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNLocalEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, ipsec_vpn_service_id=None, local_address=None, local_id=None, trust_ca_ids=None, trust_crl_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLocal endpoint represents a logical router on which tunnel needs to be terminated.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - certificate_id (
strorNone) – Site certificate identifier. Field is marked for future use. Certificate based authentication is not supported. - ipsec_vpn_service_id (
ResourceReference) – VPN Service id. - local_address (
str) – IPV4 Address for local endpoint. format: ipv4 - local_id (
strorNone) – Local identifier. - trust_ca_ids (
listofstrorNone) – Certificate authority (CA) identifier list to verify peer certificates. Field is marked for future use. Certificate based authentication is not supported. - trust_crl_ids (
listofstrorNone) – Certificate revocation list (CRL) identifier list to peer certificates. Field is marked for future use. Certificate based authentication is not supported.
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNLocalEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the local endpoints.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNLocalEndpoint) – IPSec local endpoint list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNPeerEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, authentication_mode=None, connection_initiation_mode=None, dpd_profile_id=None, ike_profile_id=None, ipsec_tunnel_profile_id=None, peer_address=None, peer_id=None, psk=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSec VPN Peer Endpoint covers configuration to be applied locally to establish a session with remote endpoint on peer site.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - authentication_mode (
strorNone) –Possible values are:
For peer authentication only Pre shared key (PSK) mode will be supported.
- connection_initiation_mode (
strorNone) –Possible values are:
IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_INITIATORIPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_RESPOND_ONLYIPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_ON_DEMAND
Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.
- dpd_profile_id (
strorNone) – Dead peer detection (DPD) profile id. Default will be set according to system default policy. - ike_profile_id (
strorNone) – IKE profile id to be used. Default will be set according to system default policy. - ipsec_tunnel_profile_id (
strorNone) – Tunnel profile id to be used. By default it will point to system default profile. - peer_address (
str) – IPV4 address of peer endpoint on remote site. - peer_id (
str) – Peer identifier. - psk (
strorNone) – IPSec Pre-shared key. Maximum length of this field is 128 characters.
-
AUTHENTICATION_MODE_PSK= 'PSK'¶
-
CONNECTION_INITIATION_MODE_INITIATOR= 'INITIATOR'¶
-
CONNECTION_INITIATION_MODE_ON_DEMAND= 'ON_DEMAND'¶
-
CONNECTION_INITIATION_MODE_RESPOND_ONLY= 'RESPOND_ONLY'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNPeerEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the peer endpoints.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNPeerEndpoint) – IPSec Peer endpoint list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNPolicyRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, destinations=None, enabled=None, logged=None, sources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFor policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy’s match criteria.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique policy id. - resource_type (
strorNone) – The type of this resource. - action (
strorNone) –Possible values are:
PROTECT - Protect rules are defined per policy based IPSec VPN session. BYPASS - Bypass rules are defined per IPSec VPN service and affects all policy based IPSec VPN sessions. Bypass rules are prioritized over protect rules. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- destinations (
listofIPSecVPNPolicySubnetorNone) – List of peer subnets. - enabled (
boolorNone) – A flag to enable/disable the policy rule. - logged (
boolorNone) – A flag to enable/disable the logging for the policy rule. - sources (
listofIPSecVPNPolicySubnetorNone) – List of local subnets.
-
ACTION_BYPASS= 'BYPASS'¶
-
ACTION_PROTECT= 'PROTECT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNPolicySubnet(subnet=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed to specify the local/peer subnets in IPSec VPN Policy rule.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: subnet ( str) – Subnet used in policy rule. format: ipv4-cidr-block
-
class
com.vmware.nsx_policy.model_client.IPSecVPNService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bypass_rules=None, enabled=None, ike_log_level=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCreate and manage IPSec VPN service for given logical router.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bypass_rules (
listofIPSecVPNPolicyRuleorNone) – Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session. - enabled (
boolorNone) – If true, enable VPN services for given logical router. - ike_log_level (
strorNone) –Possible values are:
IPSecVPNService.IKE_LOG_LEVEL_DEBUGIPSecVPNService.IKE_LOG_LEVEL_INFOIPSecVPNService.IKE_LOG_LEVEL_WARNIPSecVPNService.IKE_LOG_LEVEL_ERRORIPSecVPNService.IKE_LOG_LEVEL_EMERGENCY
Log level for internet key exchange (IKE). - logical_router_id (
str) – Logical router id.
-
IKE_LOG_LEVEL_DEBUG= 'DEBUG'¶
-
IKE_LOG_LEVEL_EMERGENCY= 'EMERGENCY'¶
-
IKE_LOG_LEVEL_ERROR= 'ERROR'¶
-
IKE_LOG_LEVEL_INFO= 'INFO'¶
-
IKE_LOG_LEVEL_WARN= 'WARN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the IPSec VPN services.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNService) – IPSec VPN serivce list result
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVPN session defines connection between local and peer endpoint. Untill VPN session is defined configuration is not realized.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
IPSecVPNSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSIONIPSecVPNSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Enable/Disable IPSec VPN session. - ipsec_vpn_service_id (
strorNone) – Identifier of VPN Service linked with local endpoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_endpoint_id (
str) – Local endpoint identifier. - peer_endpoint_id (
str) – Peer endpoint identifier.
-
RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSION= 'PolicyBasedIPSecVPNSession'¶
-
RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION= 'RouteBasedIPSecVPNSession'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the IPSec VPN sessions.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – IPSec VPN sessions list result When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inIPSecVPNSession. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inIPSecVPNSession.
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNTunnelProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, df_policy=None, dh_groups=None, digest_algorithms=None, enable_perfect_forward_secrecy=None, encapsulation_mode=None, encryption_algorithms=None, sa_life_time=None, transform_protocol=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - df_policy (
strorNone) –Possible values are:
Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.
- dh_groups (
listofstrorNone) –Possible values are:
IPSecVPNTunnelProfile.DH_GROUPS_GROUP2IPSecVPNTunnelProfile.DH_GROUPS_GROUP5IPSecVPNTunnelProfile.DH_GROUPS_GROUP14IPSecVPNTunnelProfile.DH_GROUPS_GROUP15IPSecVPNTunnelProfile.DH_GROUPS_GROUP16
Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.
- digest_algorithms (
listofstrorNone) –Possible values are:
IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA1IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_256IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_384IPSecVPNTunnelProfile.DIGEST_ALGORITHMS_SHA2_512
Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm "AES_GCM_128".
- enable_perfect_forward_secrecy (
boolorNone) – If true, perfect forward secrecy (PFS) is enabled. - encapsulation_mode (
strorNone) –Possible values are:
Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- encryption_algorithms (
listofstrorNone) –Possible values are:
IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_128IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_256IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_128IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_192IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_AES_GCM_256IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256IPSecVPNTunnelProfile.ENCRYPTION_ALGORITHMS_NO_ENCRYPTION
Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.
- sa_life_time (
longorNone) – SA life time specifies the expiry time of security association. Default is 3600 seconds. format: int64 - transform_protocol (
strorNone) –Possible values are:
IPSec transform specifies IPSec security protocol.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
DF_POLICY_CLEAR= 'CLEAR'¶
-
DF_POLICY_COPY= 'COPY'¶
-
DH_GROUPS_GROUP14= 'GROUP14'¶
-
DH_GROUPS_GROUP15= 'GROUP15'¶
-
DH_GROUPS_GROUP16= 'GROUP16'¶
-
DH_GROUPS_GROUP2= 'GROUP2'¶
-
DH_GROUPS_GROUP5= 'GROUP5'¶
-
DIGEST_ALGORITHMS_SHA1= 'SHA1'¶
-
DIGEST_ALGORITHMS_SHA2_256= 'SHA2_256'¶
-
DIGEST_ALGORITHMS_SHA2_384= 'SHA2_384'¶
-
DIGEST_ALGORITHMS_SHA2_512= 'SHA2_512'¶
-
ENCAPSULATION_MODE_MODE= 'TUNNEL_MODE'¶
-
ENCRYPTION_ALGORITHMS_AES_128= 'AES_128'¶
-
ENCRYPTION_ALGORITHMS_AES_256= 'AES_256'¶
-
ENCRYPTION_ALGORITHMS_AES_GCM_128= 'AES_GCM_128'¶
-
ENCRYPTION_ALGORITHMS_AES_GCM_192= 'AES_GCM_192'¶
-
ENCRYPTION_ALGORITHMS_AES_GCM_256= 'AES_GCM_256'¶
-
ENCRYPTION_ALGORITHMS_NO_ENCRYPTION= 'NO_ENCRYPTION'¶
-
ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_128= 'NO_ENCRYPTION_AUTH_AES_GMAC_128'¶
-
ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_192= 'NO_ENCRYPTION_AUTH_AES_GMAC_192'¶
-
ENCRYPTION_ALGORITHMS_NO_ENCRYPTION_AUTH_AES_GMAC_256= 'NO_ENCRYPTION_AUTH_AES_GMAC_256'¶
-
TRANSFORM_PROTOCOL_ESP= 'ESP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVPNTunnelProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList all the tunnel profiles.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSecVPNTunnelProfile) – IPSec Tunnel Profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnIkeSessionStatus(fail_reason=None, ike_session_state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructStatus for IPSec VPN Ike session UP, DOWN, NEGOTIATING and fail reason if Ike session is down.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - fail_reason (
strorNone) – Reason for failure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ike_session_state (
strorNone) –Possible values are:
IPSecVpnIkeSessionStatus.IKE_SESSION_STATE_UPIPSecVpnIkeSessionStatus.IKE_SESSION_STATE_DOWNIPSecVpnIkeSessionStatus.IKE_SESSION_STATE_NEGOTIATING
Ike session service status UP, DOWN and NEGOTIATING.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
IKE_SESSION_STATE_DOWN= 'DOWN'¶
-
IKE_SESSION_STATE_NEGOTIATING= 'NEGOTIATING'¶
-
IKE_SESSION_STATE_UP= 'UP'¶
- fail_reason (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnIkeTrafficStatistics(bytes_in=None, bytes_out=None, fail_count=None, packets_in=None, packets_out=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTraffic statistics for IPSec VPN Ike session. Note - Not supported in this release.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bytes_in (
longorNone) – Number of bytes in. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_out (
longorNone) – Number of bytes out. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - fail_count (
longorNone) – Fail count. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_in (
longorNone) – Number of packets in. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_out (
longorNone) – Number of packets out. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- bytes_in (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnPolicyTrafficStatistics(aggregate_traffic_counters=None, rule_path=None, tunnel_statistics=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSec VPN policy traffic statistics.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - aggregate_traffic_counters (
IPSecVpnTrafficCountersorNone) – Aggregate traffic statistics across all ipsec tunnels. - rule_path (
strorNone) – L3Vpn rule path. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tunnel_statistics (
listofIPSecVpnTunnelTrafficStatisticsorNone) – Tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- aggregate_traffic_counters (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnSessionStatistics(aggregate_traffic_counters=None, ike_status=None, ike_traffic_statistics=None, last_update_timestamp=None, policy_statistics=None, enforcement_point_path=None, resource_type='IPSecVpnSessionStatistics')¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSec VPN session statistics represents statistics on an NSX-T type of enforcement point. It gives aggregated statistics of all policies for all the tunnels.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - aggregate_traffic_counters (
IPSecVpnTrafficCountersorNone) – Aggregate traffic statistics across all ipsec tunnels. - ike_status (
IPSecVpnIkeSessionStatusorNone) – Status for IPSec VPN Ike session UP/DOWN and fail reason if Ike session is down. - ike_traffic_statistics (
IPSecVpnIkeTrafficStatisticsorNone) – Traffic statistics for IPSec VPN Ike session. Note - Not supported in this release. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - policy_statistics (
listofIPSecVpnPolicyTrafficStatisticsorNone) – Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- aggregate_traffic_counters (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnTrafficCounters(bytes_in=None, bytes_out=None, dropped_packets_in=None, dropped_packets_out=None, packets_in=None, packets_out=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTraffic counters for IPSec VPN session.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bytes_in (
longorNone) – Total number of bytes recevied. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_out (
longorNone) – Total number of bytes sent. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dropped_packets_in (
longorNone) – Total number of incoming packets dropped on inbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dropped_packets_out (
longorNone) – Total number of outgoing packets dropped on outbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_in (
longorNone) – Total number of packets received. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_out (
longorNone) – Total number of packets sent. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- bytes_in (
-
class
com.vmware.nsx_policy.model_client.IPSecVpnTunnelTrafficStatistics(bytes_in=None, bytes_out=None, decryption_failures=None, dropped_packets_in=None, dropped_packets_out=None, encryption_failures=None, integrity_failures=None, local_subnet=None, nomatching_policy_errors=None, packets_in=None, packets_out=None, packets_received_other_error=None, packets_sent_other_error=None, remote_subnet=None, replay_errors=None, sa_mismatch_errors_in=None, sa_mismatch_errors_out=None, seq_number_overflow_error=None, tunnel_down_reason=None, tunnel_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSec VPN tunnel traffic statistics.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bytes_in (
longorNone) – Total number of incoming bytes on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_out (
longorNone) – Total number of outgoing bytes on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - decryption_failures (
longorNone) – Total number of packets dropped due to decryption failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dropped_packets_in (
longorNone) – Total number of incoming packets dropped on inbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dropped_packets_out (
longorNone) – Total number of outgoing packets dropped on outbound security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - encryption_failures (
longorNone) – Total number of packets dropped because of failure in encryption. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - integrity_failures (
longorNone) – Total number of packets dropped due to integrity failures. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_subnet (
strorNone) – Local subnet to which a tunnel belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - nomatching_policy_errors (
longorNone) – Number of packets dropped because of no matching policy is available. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_in (
longorNone) – Total number of incoming packets on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_out (
longorNone) – Total number of outgoing packets on outbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_received_other_error (
longorNone) – Total number of incoming packets dropped on inbound Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_sent_other_error (
longorNone) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_subnet (
strorNone) – Peer subnet to which a tunnel belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - replay_errors (
longorNone) – Total number of packets dropped due to replay check on that Security association. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sa_mismatch_errors_in (
longorNone) – Totoal number of security association mismatch errors on incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sa_mismatch_errors_out (
longorNone) – Totoal number of security association mismatch errors on outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - seq_number_overflow_error (
longorNone) – Total number of packets dropped while sending due to overflow in sequence number. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tunnel_down_reason (
strorNone) – Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tunnel_status (
strorNone) –Possible values are:
Specifies the status of tunnel, if it is UP/DOWN.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
TUNNEL_STATUS_DOWN= 'DOWN'¶
-
TUNNEL_STATUS_UP= 'UP'¶
- bytes_in (
-
class
com.vmware.nsx_policy.model_client.IPSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPSet is used to group individual IP addresses, range of IP addresses or subnets. An IPSet is a homogeneous group of IP addresses, either of type IPv4 or of type IPv6. IPSets can be used as source or destination in firewall rules. These can also be used as members of NSGroups.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ip_addresses (
listofstrorNone) – IP addresses format: address-or-block-or-range
- links (
-
class
com.vmware.nsx_policy.model_client.IPSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of IPSets
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIPSet) – IPSet list results
- links (
-
class
com.vmware.nsx_policy.model_client.IPSubnet(ip_addresses=None, prefix_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstr) – IPv4 Addresses format: ipv4 - prefix_length (
long) – Subnet Prefix Length format: int64
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.IPv4DhcpServer(dhcp_server_ip=None, dns_nameservers=None, domain_name=None, gateway_ip=None, options=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - dhcp_server_ip (
str) – dhcp server ip in cidr format format: ipv4-cidr-block - dns_nameservers (
listofstrorNone) – dns ips format: ipv4 - domain_name (
strorNone) – domain name format: hostname - gateway_ip (
strorNone) – gateway ip format: ipv4 - options (
DhcpOptionsorNone) – Defines the default options for all ip-pools and static-bindings of this server. These options will be ignored if options are defined for ip-pools or static-bindings.
- dhcp_server_ip (
-
class
com.vmware.nsx_policy.model_client.Icon(placement=None, tooltip=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIcon to be applied at dashboard for widgets and UI elements.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - placement (
strorNone) –Possible values are:
If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.
- tooltip (
listofTooltiporNone) – Multi-line text to be shown on tooltip while hovering over the icon. - type (
strorNone) –Possible values are:
Icon.TYPE_ERRORIcon.TYPE_WARNINGIcon.TYPE_INFOIcon.TYPE_INPROGRESSIcon.TYPE_SUCCESSIcon.TYPE_DETAILIcon.TYPE_NOT_AVAILABLE
Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered.
-
PLACEMENT_POST= 'POST'¶
-
PLACEMENT_PRE= 'PRE'¶
-
TYPE_DETAIL= 'DETAIL'¶
-
TYPE_ERROR= 'ERROR'¶
-
TYPE_INFO= 'INFO'¶
-
TYPE_INPROGRESS= 'INPROGRESS'¶
-
TYPE_NOT_AVAILABLE= 'NOT_AVAILABLE'¶
-
TYPE_SUCCESS= 'SUCCESS'¶
-
TYPE_WARNING= 'WARNING'¶
- placement (
-
class
com.vmware.nsx_policy.model_client.IncludedFieldsParameters(included_fields=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA list of fields to include in query results
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: included_fields ( strorNone) – Comma separated list of fields that should be included in query result
-
class
com.vmware.nsx_policy.model_client.Infra(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, connectivity_strategy=None, domains=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInfra space related policy
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - connectivity_strategy (
strorNone) –Possible values are:
Infra.CONNECTIVITY_STRATEGY_WHITELISTInfra.CONNECTIVITY_STRATEGY_BLACKLISTInfra.CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGINGInfra.CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGINGInfra.CONNECTIVITY_STRATEGY_NONE
This field indicates the default connectivity policy for the infra or tenant space WHITELIST - Adds a default drop rule. Administrator can then use "allow" rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use "drop" rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rules are added. This is the default setting
- domains (
listofDomainorNone) – This field is used while creating or updating the infra space.
-
CONNECTIVITY_STRATEGY_BLACKLIST= 'BLACKLIST'¶
-
CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING= 'BLACKLIST_ENABLE_LOGGING'¶
-
CONNECTIVITY_STRATEGY_NONE= 'NONE'¶
-
CONNECTIVITY_STRATEGY_WHITELIST= 'WHITELIST'¶
-
CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING= 'WHITELIST_ENABLE_LOGGING'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IngressBroadcastRateShaper(enabled=None, resource_type=None, average_bandwidth_kbps=None, burst_size_bytes=None, peak_bandwidth_kbps=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA shaper that specifies ingress rate properties in kb/s
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – - resource_type (
strorNone) –Possible values are:
- average_bandwidth_kbps (
longorNone) – Average bandwidth in kb/s format: int32 - burst_size_bytes (
longorNone) – Burst size in bytes format: int32 - peak_bandwidth_kbps (
longorNone) – Peak bandwidth in kb/s format: int32
-
RESOURCE_TYPE_EGRESSRATESHAPER= 'EgressRateShaper'¶
-
RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER= 'IngressBroadcastRateShaper'¶
-
RESOURCE_TYPE_INGRESSRATESHAPER= 'IngressRateShaper'¶
- enabled (
-
class
com.vmware.nsx_policy.model_client.IngressRateShaper(enabled=None, resource_type=None, average_bandwidth_mbps=None, burst_size_bytes=None, peak_bandwidth_mbps=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA shaper that specifies ingress rate properties in Mb/s
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – - resource_type (
strorNone) –Possible values are:
- average_bandwidth_mbps (
longorNone) – Average bandwidth in Mb/s format: int32 - burst_size_bytes (
longorNone) – Burst size in bytes format: int32 - peak_bandwidth_mbps (
longorNone) – Peak bandwidth in Mb/s format: int32
-
RESOURCE_TYPE_EGRESSRATESHAPER= 'EgressRateShaper'¶
-
RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER= 'IngressBroadcastRateShaper'¶
-
RESOURCE_TYPE_INGRESSRATESHAPER= 'IngressRateShaper'¶
- enabled (
-
class
com.vmware.nsx_policy.model_client.InitiateClusterRestoreRequest(node_id=None, timestamp=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - node_id (
strorNone) – Unique id of the backed-up configuration from which the appliance will be restored This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp of the backed-up configuration from which the appliance will be restored format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- node_id (
-
class
com.vmware.nsx_policy.model_client.InstanceDeploymentConfig(compute_id=None, context_id=None, storage_id=None, vm_nic_infos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe Instance Deployment Config contains settings that is applied during install time.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - compute_id (
str) – Resource Pool or Compute Id. - context_id (
str) – Context Id or VCenter Id. - storage_id (
str) – Storage Id. - vm_nic_infos (
listofVmNicInfo) – List of set of NIC information for VMs
- compute_id (
-
class
com.vmware.nsx_policy.model_client.InstanceEndpoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, endpoint_type=None, link_ids=None, service_attachments=None, target_ips=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn InstanceEndpoint belongs to one ServiceInstance and represents a redirection target for a Rule. For Example - It can be an L3 Destination. Service Attachments is required for a InstanceEndpoint of type LOGICAL, and deployed_to if its a VIRTUAL InstanceEndpoint.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - endpoint_type (
strorNone) –Possible values are:
LOGICAL - It must be created with a ServiceAttachment and identifies a destination connected to the Service Port of the ServiceAttachment, through the ServiceAttachment’s Logical Switch. VIRTUAL - It represents a L3 destination the router can route to but does not provide any further information about its location in the network. Virtual InstanceEndpoints are used for redirection targets that are not connected to Service Ports, such as the next-hop routers on the Edge uplinks.
- link_ids (
listofResourceReferenceorNone) – Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though VIRTUAL, the Instance Endpoint should be connected/accessible through an NSX object. The link id is this NSX object id. Example - For North-South Service Insertion, this is the LogicalRouter Id through which the targetIp/L3 destination accessible. - service_attachments (
listofResourceReferenceorNone) – Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint. - target_ips (
listofIPInfo) – Target IPs on an interface of the Service Instance.
-
ENDPOINT_TYPE_LOGICAL= 'LOGICAL'¶
-
ENDPOINT_TYPE_VIRTUAL= 'VIRTUAL'¶
- links (
-
class
com.vmware.nsx_policy.model_client.InstanceEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of instance endpoints.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofInstanceEndpointorNone) – List of instance endpoints. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.InstanceRuntime(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, deployment_status=None, error_message=None, runtime_status=None, service_instance_id=None, service_vm_id=None, vm_nic_info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Service Runtime is the runtime entity associated with ever Service-VM deployed.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - deployment_status (
strorNone) –Possible values are:
InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESSInstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_FAILEDInstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFULInstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESSInstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_FAILEDInstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESSInstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILEDInstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFULInstanceRuntime.DEPLOYMENT_STATUS_UNKNOWN
Service-Instance Runtime deployment status of the Service-VM. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment of VM. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- error_message (
strorNone) – Error message for the Service Instance Runtime if any. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - runtime_status (
strorNone) –Possible values are:
InstanceRuntime.RUNTIME_STATUS_IN_SERVICEInstanceRuntime.RUNTIME_STATUS_OUT_OF_SERVICEInstanceRuntime.RUNTIME_STATUS_NEEDS_ATTENTIONInstanceRuntime.RUNTIME_STATUS_NOT_AVAILABLE
Service-Instance Runtime status of the deployed Service-VM.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- service_instance_id (
strorNone) – Id of an instantiation of a registered service. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_vm_id (
strorNone) – Service-VM/SVM id of deployed virtual-machine. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_nic_info (
VmNicInfoorNone) – VM NIC info
-
DEPLOYMENT_STATUS_DEPLOYMENT_FAILED= 'DEPLOYMENT_FAILED'¶
-
DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESS= 'DEPLOYMENT_IN_PROGRESS'¶
-
DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFUL= 'DEPLOYMENT_SUCCESSFUL'¶
-
DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILED= 'UNDEPLOYMENT_FAILED'¶
-
DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESS= 'UNDEPLOYMENT_IN_PROGRESS'¶
-
DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFUL= 'UNDEPLOYMENT_SUCCESSFUL'¶
-
DEPLOYMENT_STATUS_UNKNOWN= 'UNKNOWN'¶
-
DEPLOYMENT_STATUS_UPGRADE_FAILED= 'UPGRADE_FAILED'¶
-
DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS= 'UPGRADE_IN_PROGRESS'¶
-
RUNTIME_STATUS_IN_SERVICE= 'IN_SERVICE'¶
-
RUNTIME_STATUS_NEEDS_ATTENTION= 'NEEDS_ATTENTION'¶
-
RUNTIME_STATUS_NOT_AVAILABLE= 'NOT_AVAILABLE'¶
-
RUNTIME_STATUS_OUT_OF_SERVICE= 'OUT_OF_SERVICE'¶
- links (
-
class
com.vmware.nsx_policy.model_client.InstanceRuntimeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructResult of List of InstanceRuntimes
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofInstanceRuntime) – Array of existing InstanceRuntimes in database
- links (
-
class
com.vmware.nsx_policy.model_client.InstructionInfo(actions=None, fields=None, id=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDetails of the instructions displayed during restore process
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - actions (
listofstrorNone) – A list of actions that are to be applied to resources This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - fields (
listofstrorNone) – A list of fields that are displayable to users in a table This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - id (
strorNone) – UUID of the instruction This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – Instruction name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- actions (
-
class
com.vmware.nsx_policy.model_client.InterfaceNeighborProperties(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ifindex=None, mac=None, name=None, neighbors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInterface neighbor properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ifindex (
longorNone) – Interface index format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac (
strorNone) – Interface MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – Interface Name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - neighbors (
listofNeighborPropertiesorNone) – Neighbor properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.InterfaceNeighborPropertyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInterface neighbor property query results
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofInterfaceNeighborPropertiesorNone) – Interface neighbor property results
- links (
-
class
com.vmware.nsx_policy.model_client.InterfaceStatistics(links=None, schema=None, self_=None, rx_bytes=None, rx_errors=None, rx_packets=None, tx_bytes=None, tx_errors=None, tx_packets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructStatistics for a network interface
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - rx_bytes (
longorNone) – Count of bytes received on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rx_errors (
longorNone) – Count of receive errors occurring on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rx_packets (
longorNone) – Count of packets received on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tx_bytes (
longorNone) – Count of bytes transmitted on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tx_errors (
longorNone) – Count of transmit errors occurring on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tx_packets (
longorNone) – Count of packets transmitted on this port format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.InterfaceSubnet(ip_addresses=None, prefix_len=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSubnet specification for interface connectivity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstr) – IP addresses assigned to interface format: ip - prefix_len (
long) – Subnet prefix length format: int32
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.IntervalBackupSchedule(seconds_between_backups=None, resource_type='IntervalBackupSchedule')¶ Bases:
vmware.vapi.bindings.struct.VapiStructSchedule to specify the interval time at which automated backups need to be taken
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - seconds_between_backups (
longorNone) – Time interval in seconds between two consecutive automated backups format: int64 - resource_type (
str) –Possible values are:
BackupSchedule.RESOURCE_TYPE_WEEKLYBACKUPSCHEDULEBackupSchedule.RESOURCE_TYPE_INTERVALBACKUPSCHEDULE
Schedule type
- seconds_between_backups (
-
class
com.vmware.nsx_policy.model_client.IpAddressInfo(ip_addresses=None, source=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIpaddress information of the fabric node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstrorNone) – IP Addresses of the the virtual network interface, as discovered in the source. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source (
strorNone) –Possible values are:
Source of the ipaddress information.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SOURCE_TOOLS= 'VM_TOOLS'¶
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.IpAllocationBase(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, gateway_ip=None, lease_time=None, options=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - gateway_ip (
strorNone) – gateway ip format: ip - lease_time (
longorNone) – lease time, in seconds, [60-(2^32-1)], default 86400 format: int64 - options (
DhcpOptionsorNone) – If an option is defined at server level and not configred at ip-pool/static-binding level, the option will be inherited to ip-pool/static-binding. If both define a same-code option, the option defined at ip-pool/static-binding level take precedence over that defined at server level.
- links (
-
class
com.vmware.nsx_policy.model_client.IpAssignmentSpec(resource_type='IpAssignmentSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base type for specification of IPs to be used with host switch virtual tunnel endpoints
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
-
RESOURCE_TYPE_ASSIGNEDBYDHCP= 'AssignedByDhcp'¶
-
RESOURCE_TYPE_STATICIPLISTSPEC= 'StaticIpListSpec'¶
-
RESOURCE_TYPE_STATICIPMACLISTSPEC= 'StaticIpMacListSpec'¶
-
RESOURCE_TYPE_STATICIPPOOLSPEC= 'StaticIpPoolSpec'¶
-
-
class
com.vmware.nsx_policy.model_client.IpBlock(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cidr=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA block of IPv4 addresses defined by a start address and a mask/prefix (network CIDR). An IP block is typically large & allocated to a tenant for automated consumption. An IP block is always a contiguous address space, for example 192.0.0.1/8. An IP block can be further subdivided into subnets called IP block subnets. These IP block subnets can later be added to IP pools and used for IP allocation. An IP pool is typically a collection of subnets that are often not a contiguous address space. Clients are allocated IP addresses only from IP pools. Sample Structure Diagram IpBlock_VMware 192.0.0.1/8 ======================================================================= / ___________________________________________/________ / IpBlockSubnet_Finance ( IpBlockSubnet_Eng1 IpBlockSubnet_Eng2 / ) / 192.168.0.1/16 ( 192.170.1.1/16 192.180.1.1/24 / ) IpPool_Eng / (___________________________________________/________) / / =======================================================================
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cidr (
str) – Represents network address and the prefix length which will be associated with a layer-2 broadcast domain format: ipv4-cidr-block
- links (
-
class
com.vmware.nsx_policy.model_client.IpBlockListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpBlock) – IP block list results
- links (
-
class
com.vmware.nsx_policy.model_client.IpBlockSubnet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, allocation_ranges=None, block_id=None, cidr=None, size=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA set of IPv4 addresses defined by a start address and a mask/prefix which will typically be associated with a layer-2 broadcast domain.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - allocation_ranges (
listofIpPoolRangeorNone) – A collection of IPv4 IP ranges used for IP allocation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - block_id (
str) – Block id for which the subnet is created. - cidr (
strorNone) – Represents network address and the prefix length which will be associated with a layer-2 broadcast domain format: ipv4-cidr-block This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - size (
long) – Represents the size or number of ip addresses in the subnet format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.IpBlockSubnetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpBlockSubnet) – IP block subnet list results
- links (
-
class
com.vmware.nsx_policy.model_client.IpDiscoverySwitchingProfile(arp_bindings_limit=None, arp_snooping_enabled=None, dhcp_snooping_enabled=None, vm_tools_enabled=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpDiscoverySwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - arp_bindings_limit (
longorNone) – Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. format: int32 - arp_snooping_enabled (
boolorNone) – Indicates whether ARP snooping is enabled - dhcp_snooping_enabled (
boolorNone) – Indicates whether DHCP snooping is enabled - vm_tools_enabled (
boolorNone) – This option is only supported on ESX where vm-tools is installed. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- arp_bindings_limit (
-
class
com.vmware.nsx_policy.model_client.IpMacPair(ip=None, mac=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIP and MAC pair.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip (
str) – IP address format: ip - mac (
strorNone) – MAC address
- ip (
-
class
com.vmware.nsx_policy.model_client.IpPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pool_usage=None, subnets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA collection of one or more IPv4 or IPv6 subnets or ranges that are often not a contiguous address space. Clients are allocated IPs from an IP pool. Often used when a client that consumes addresses exhausts an initial subnet or range and needs to be expanded but the adjoining address space is not available as it has been allocated to a different client.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - pool_usage (
PoolUsageorNone) – Pool usage statistics - subnets (
listofIpPoolSubnetorNone) – Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.
- links (
-
class
com.vmware.nsx_policy.model_client.IpPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpPool) – IP pool list results
- links (
-
class
com.vmware.nsx_policy.model_client.IpPoolRange(links=None, schema=None, self_=None, end=None, start=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA set of IPv4 or IPv6 addresses defined by a start and end address.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - end (
str) – The end IP Address of the IP Range. format: ip - start (
str) – The start IP Address of the IP Range. format: ip
- links (
-
class
com.vmware.nsx_policy.model_client.IpPoolSubnet(links=None, schema=None, self_=None, allocation_ranges=None, cidr=None, dns_nameservers=None, dns_suffix=None, gateway_ip=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA set of IPv4 or IPv6 addresses defined by a network CIDR.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - allocation_ranges (
listofIpPoolRange) – A collection of IPv4 or IPv6 IP Pool Ranges. - cidr (
str) – Represents network address and the prefix length which will be associated with a layer-2 broadcast domain - dns_nameservers (
listofstrorNone) – The collection of upto 3 DNS servers for the subnet. format: ip - dns_suffix (
strorNone) – The DNS suffix for the DNS server. format: hostname - gateway_ip (
strorNone) – The default gateway address on a layer-3 router. format: ip
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixCollector(collector_ip_address=None, collector_port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - collector_ip_address (
str) – IP address for the IPFIX collector format: ip - collector_port (
longorNone) – Port for the IPFIX collector format: int32
- collector_ip_address (
-
class
com.vmware.nsx_policy.model_client.IpfixCollectorConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, collectors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis managed entity contains a set of IPFIX collectors.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - collectors (
listofIpfixCollector) – IPFIX Collectors
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixCollectorConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of IPFIX Collector Configs
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpfixCollectorConfigorNone) – IPFIX Collector Config This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixCollectorUpmProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, collectors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe configuration for Internet protocol flow information export (IPFIX) collector. It should be referenced in other IPFIX profile as a collecor config. The IPFIX exporter will send records to these collectors.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
All IPFIX collector profile types.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - collectors (
listofIpfixCollector) – IPFIX Collector Set
-
RESOURCE_TYPE_IPFIXCOLLECTORUPMPROFILE= 'IpfixCollectorUpmProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixCollectorUpmProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX collector profile list result for query with profile list parameters
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpfixCollectorUpmProfileorNone) – IPFIX Collector Profile List This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixConfig', tags=None, applied_tos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX Config base representation
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Supported IPFIX Config Types. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the IPFIX Config will be enabled.
-
RESOURCE_TYPE_IPFIXDFWCONFIG= 'IpfixDfwConfig'¶
-
RESOURCE_TYPE_IPFIXSWITCHCONFIG= 'IpfixSwitchConfig'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixConfigListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of IPFIX Config
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – IPFIX Config When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inIpfixConfig. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inIpfixConfig. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixDfwConfig(active_flow_export_timeout=None, collector=None, observation_domain_id=None, priority=None, template_parameters=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixDfwConfig', tags=None, applied_tos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIt defines IPFIX DFW Configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - active_flow_export_timeout (
longorNone) – For long standing active flows, IPFIX records will be sent per timeout period format: int64 - collector (
str) – Each IPFIX DFW config can have its own collector config. - observation_domain_id (
long) – An identifier that is unique to the exporting process and used to meter the Flows. format: int64 - priority (
long) – This priority field is used to resolve conflicts in Logical Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only. format: int64 - template_parameters (
IpfixDfwTemplateParametersorNone) – An object that indicates whether each corresponding template parameter is required or not. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Supported IPFIX Config Types. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the IPFIX Config will be enabled.
- active_flow_export_timeout (
-
class
com.vmware.nsx_policy.model_client.IpfixDfwTemplateParameters(destination_address=None, destination_transport_port=None, firewall_event=None, flow_direction=None, flow_end=None, flow_start=None, icmp_code=None, octet_delta_count=None, packet_delta_count=None, protocol_identifier=None, rule_id=None, source_address=None, source_icmp_type=None, source_transport_port=None, vif_uuid=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis entity represents the flow parameters which are exported.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - destination_address (
boolorNone) – The destination IP address of a monitored network flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - destination_transport_port (
boolorNone) – The destination transport port of a monitored network flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - firewall_event (
boolorNone) – Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. Flow Denied. 4. Flow Alert (not used in DropKick implementation). 5. Flow Update. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - flow_direction (
boolorNone) – Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: egress flow from VM. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - flow_end (
boolorNone) – The absolute timestamp (seconds) of the last packet of this flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - flow_start (
boolorNone) – The absolute timestamp (seconds) of the first packet of this flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - icmp_code (
boolorNone) – Code of the IPv4 ICMP message. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - octet_delta_count (
boolorNone) – The number of octets since the previous report (if any) in incoming packets for this flow at the observation point. The number of octets include IP header(s) and payload. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packet_delta_count (
boolorNone) – The number of incoming packets since the previous report (if any) for this flow at the observation point. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protocol_identifier (
boolorNone) – The value of the protocol number in the IP packet header. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_id (
boolorNone) – Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source_address (
boolorNone) – The source IP address of a monitored network flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source_icmp_type (
boolorNone) – Type of the IPv4 ICMP message. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source_transport_port (
boolorNone) – The source transport port of a monitored network flow. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vif_uuid (
boolorNone) – VIF UUID - enterprise specific Information Element that uniquely identifies VIF. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- destination_address (
-
class
com.vmware.nsx_policy.model_client.IpfixObsPointConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, active_timeout=None, collectors=None, enabled=None, idle_timeout=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIpfixObsPointConfig (i.e. global switch IPFIX config) is deprecated. Please use IpfixSwitchUpmProfile & IpfixCollectorUpmProfile instead. With them, switch IPFIX profile can be applied to specific entities, such as logical switch, logical port and so on.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - active_timeout (
longorNone) – The time in seconds after a Flow is expired even if more packets matching this Flow are received by the cache. format: int32 - collectors (
listofIpfixCollectororNone) – List of IPFIX collectors - enabled (
bool) – Enabled status of IPFIX export - idle_timeout (
longorNone) – The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache. format: int32 - max_flows (
longorNone) – The maximum number of flow entries in each exporter flow cache. format: int64 - observation_domain_id (
longorNone) – An identifier that is unique to the exporting process and used to meter the Flows. format: int64 - packet_sample_probability (
floatorNone) – The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixObsPointsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis is deprecated. Please use UpmProfileListResult instead.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofIpfixObsPointConfigorNone) – IPFIX observation points
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixServiceAssociationListResult(results=None, links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='IpfixServiceAssociationListResult')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - results (
listofvmware.vapi.struct.VapiStructorNone) – Ipfix config list result with pagination support. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inIpfixConfig. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inIpfixConfig. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_type (
str) –Possible values are:
- results (
-
class
com.vmware.nsx_policy.model_client.IpfixSwitchConfig(active_timeout=None, idle_timeout=None, max_flows=None, packet_sample_probability=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixSwitchConfig', tags=None, applied_tos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis is deprecated. Please use IpfixSwitchUpmProfile instead which can specify its own collectors and observation ID.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - active_timeout (
longorNone) – The time in seconds after a Flow is expired even if more packets matching this Flow are received by the cache. format: int32 - idle_timeout (
longorNone) – The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache. format: int32 - max_flows (
longorNone) – The maximum number of flow entries in each exporter flow cache. format: int64 - packet_sample_probability (
floatorNone) – The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Supported IPFIX Config Types. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the IPFIX Config will be enabled.
- active_timeout (
-
class
com.vmware.nsx_policy.model_client.IpfixSwitchUpmProfile(active_timeout=None, applied_tos=None, collector_profile=None, idle_timeout=None, max_flows=None, observation_domain_id=None, packet_sample_probability=None, priority=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixSwitchUpmProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe configuration for Internet protocol flow information export (IPFIX) and would be enabled on the switching module to collect flow information.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - active_timeout (
longorNone) – The time in seconds after a flow is expired even if more packets matching this Flow are received by the cache. format: int32 - applied_tos (
AppliedTosorNone) – Entities where the IPFIX profile will be enabled on. Maximum entity count of all types is 128. - collector_profile (
str) – Each IPFIX switching profile can have its own collector profile. - idle_timeout (
longorNone) – The time in seconds after a flow is expired if no more packets matching this flow are received by the cache. format: int32 - max_flows (
longorNone) – The maximum number of flow entries in each exporter flow cache. format: int64 - observation_domain_id (
long) – An identifier that is unique to the exporting process and used to meter the Flows. format: int64 - packet_sample_probability (
floatorNone) – The probability in percentage that a packet is sampled, in range (0,100]. The probability is equal for every packet. - priority (
long) – This priority field is used to resolve conflicts in logical ports/switch which inherit multiple switch IPFIX profiles from NSGroups. Override rule is : for multiple profiles inherited from NSGroups, the one with highest priority (lowest number) overrides others; the profile directly applied to logical switch overrides profiles inherited from NSGroup; the profile directly applied to logical port overides profiles inherited from logical switch and/or nsgroup; The IPFIX exporter will send records to collectors of final effective profile only. format: int32 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
All IPFIX profile types. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- active_timeout (
-
class
com.vmware.nsx_policy.model_client.IpfixUpmProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='IpfixUpmProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructParent profile of all IPFIX profiles.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
All IPFIX profile types. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_IPFIXSWITCHUPMPROFILE= 'IpfixSwitchUpmProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.IpfixUpmProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIPFIX profile list result for query with list parameters
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – IPFIX Profile List When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inIpfixUpmProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inIpfixUpmProfile. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.KeyValue(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
str) – key name - value (
str) – key value
- key (
-
class
com.vmware.nsx_policy.model_client.KeyValuePair(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn arbitrary key-value pair
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
str) – Key - value (
str) – Value
- key (
-
class
com.vmware.nsx_policy.model_client.L2Extension(l2vpn_paths=None, tunnel_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSegment specific L2 VPN configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - l2vpn_paths (
listofstrorNone) – Policy paths corresponding to the associated L2 VPN sessions. - tunnel_id (
longorNone) – Tunnel ID format: int32
- l2vpn_paths (
-
class
com.vmware.nsx_policy.model_client.L2Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enabled=None, transport_tunnels=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains information necessary to configure L2Vpn.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enabled (
boolorNone) – Enable to extend all the associated segments. - transport_tunnels (
listofstr) – List of paths referencing transport tunnels.
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnAttachmentContext(tunnel_id=None, allocate_addresses=None, resource_type='L2VpnAttachmentContext')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - tunnel_id (
long) – Tunnel Id to uniquely identify the extension. format: int32 - allocate_addresses (
strorNone) –Possible values are:
AttachmentContext.ALLOCATE_ADDRESSES_IPPOOLAttachmentContext.ALLOCATE_ADDRESSES_MACPOOLAttachmentContext.ALLOCATE_ADDRESSES_BOTHAttachmentContext.ALLOCATE_ADDRESSES_NONE
A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
- resource_type (
str) – Used to identify which concrete class it is
- tunnel_id (
-
class
com.vmware.nsx_policy.model_client.L2VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enable_hub=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructL2Vpn Context provides meta-data information about the parent Tier-0.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enable_hub (
boolorNone) – If enabled, the tier-0 acts as a Hub and replicates traffic received from peer to all other peers. If disabled, the tier-0 acts as a Spoke and replicates only the local.
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of L2Vpns
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofL2Vpn) – L2Vpn list results
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnPeerCodes(peer_codes=None, enforcement_point_path=None, resource_type='L2VpnPeerCodes')¶ Bases:
vmware.vapi.bindings.struct.VapiStructGet the peer_code for each tunnel to paste on the remote end of the tunnel. Currently only stand-along/unmanaged edge is supported on the remote end of the tunnel.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - peer_codes (
listofL2VpnTransportTunnelPeerCode) – List of peer codes per transport tunnel. - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point to which the config belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- peer_codes (
-
class
com.vmware.nsx_policy.model_client.L2VpnPeerConfigPerEnforcementPoint(enforcement_point_path=None, resource_type='L2VpnPeerConfigPerEnforcementPoint')¶ Bases:
vmware.vapi.bindings.struct.VapiStructPeer config per Enforcement Point to configure the other side of the tunnel.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point to which the config belongs. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
-
RESOURCE_TYPE_L2VPNPEERCODES= 'L2VpnPeerCodes'¶
- enforcement_point_path (
-
class
com.vmware.nsx_policy.model_client.L2VpnPerSegmentTrafficStatistics(bum_bytes_in=None, bum_bytes_out=None, bum_packets_in=None, bum_packets_out=None, bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None, segment_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTraffic statistics for a segment.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bum_bytes_in (
longorNone) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bum_bytes_out (
longorNone) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bum_packets_in (
longorNone) – Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bum_packets_out (
longorNone) – Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_in (
longorNone) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_out (
longorNone) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_in (
longorNone) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_out (
longorNone) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_receive_error (
longorNone) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_sent_error (
longorNone) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - segment_path (
strorNone) – Policy path referencing the segment on which stats are gathered. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- bum_bytes_in (
-
class
com.vmware.nsx_policy.model_client.L2VpnService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enable_full_mesh=None, logical_router_id=None, logical_tap_ip_pool=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDefines if service running as hub or spoke Also defines all the common properties for the multiple L2VpnSessions associated with this service.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enable_full_mesh (
boolorNone) – Hub replicates traffic received from peer to all other peers. - logical_router_id (
str) – Logical router id - logical_tap_ip_pool (
listofstrorNone) – IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap. format: ipv4-cidr-block
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaginated list all the L2VPN services.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofL2VpnService) – L2VPN serivce list result
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, enabled=None, l2vpn_service_id=None, transport_tunnels=None, tunnel_encapsulation=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDefines the tunnel local and peer addresses along with the multiple tansport tunnels for redundancy. L2VpnSession belongs on to only one L2VpnService.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Enable to extend all the associated logical switches. - l2vpn_service_id (
str) – L2VPN service id - transport_tunnels (
listofResourceReference) – List of transport tunnels for redundancy. - tunnel_encapsulation (
L2VpnTunnelEncapsulationorNone) – Tunnel encapsulation config.
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaginated list all the L2VPN sessions
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofL2VpnSession) – L2VPN sessions list result
- links (
-
class
com.vmware.nsx_policy.model_client.L2VpnSessionStatistics(tap_traffic_counters=None, traffic_statistics_per_segment=None, enforcement_point_path=None, resource_type='L2VpnSessionStatistics')¶ Bases:
vmware.vapi.bindings.struct.VapiStructSession statistics gives VPN session status and traffic statistics per segment.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - tap_traffic_counters (
listofL2VpnTapTrafficStatisticsorNone) – Tunnel port traffic counters. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - traffic_statistics_per_segment (
listofL2VpnPerSegmentTrafficStatisticsorNone) – Traffic statistics per segment. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tap_traffic_counters (
-
class
com.vmware.nsx_policy.model_client.L2VpnStatisticsPerEnforcementPoint(enforcement_point_path=None, resource_type='L2VpnStatisticsPerEnforcementPoint')¶ Bases:
vmware.vapi.bindings.struct.VapiStructL2Vpn Statistics Per Enforcement Point.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
-
RESOURCE_TYPE_L2VPNSESSIONSTATISTICS= 'L2VpnSessionStatistics'¶
- enforcement_point_path (
-
class
com.vmware.nsx_policy.model_client.L2VpnTapTrafficStatistics(bytes_in=None, bytes_out=None, packets_in=None, packets_out=None, packets_receive_error=None, packets_sent_error=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTAP (Terminal access point) traffic statistics for L2Vpn.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bytes_in (
longorNone) – Total number of incoming bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - bytes_out (
longorNone) – Total number of outgoing bytes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_in (
longorNone) – Total number of incoming packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_out (
longorNone) – Total number of outgoing packets. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_receive_error (
longorNone) – Total number of incoming packets dropped. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_sent_error (
longorNone) – Total number of packets dropped while sending for any reason. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- bytes_in (
-
class
com.vmware.nsx_policy.model_client.L2VpnTransportTunnelPeerCode(peer_code=None, transport_tunnel_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructL2Vpn transport tunnel peer code.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - peer_code (
str) – Copy this code to paste on the remote end of the tunnel. This is a base64 encoded string which has all the configuration for tunnel. E.g local/remote ips and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it. - transport_tunnel_path (
str) – Policy Path referencing the transport tunnel.
- peer_code (
-
class
com.vmware.nsx_policy.model_client.L2VpnTunnelEncapsulation(local_endpoint_ip=None, peer_endpoint_ip=None, protocol=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructL2VPN tunnel encapsulation config
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - local_endpoint_ip (
strorNone) – IP Address of the tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService get the same local_endpoint_ip. format: ipv4 - peer_endpoint_ip (
strorNone) – IP Address of the peer tunnel port. The IP are allocated from L2VpnService logical_tap_ip_pool. format: ipv4 - protocol (
strorNone) –Possible values are:
Encapsulation protocol used by the tunnel
-
PROTOCOL_GRE= 'GRE'¶
- local_endpoint_ip (
-
class
com.vmware.nsx_policy.model_client.L3Vpn(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dh_groups=None, enable_perfect_forward_secrecy=None, enabled=None, ike_digest_algorithms=None, ike_encryption_algorithms=None, ike_version=None, l3vpn_session=None, local_address=None, passphrases=None, remote_private_address=None, remote_public_address=None, tunnel_digest_algorithms=None, tunnel_encryption_algorithms=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains information necessary to configure IPSec VPN.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dh_groups (
listofstrorNone) –Possible values are:
L3Vpn.DH_GROUPS_GROUP2L3Vpn.DH_GROUPS_GROUP5L3Vpn.DH_GROUPS_GROUP14L3Vpn.DH_GROUPS_GROUP15L3Vpn.DH_GROUPS_GROUP16
Diffie-Hellman group to be used if PFS is enabled. Default group is GROUP14.
- enable_perfect_forward_secrecy (
boolorNone) – If true, perfect forward secrecy (PFS) is enabled. - enabled (
boolorNone) – Flag to enable L3Vpn. Default is enabled. - ike_digest_algorithms (
listofstrorNone) –Possible values are:
Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.
- ike_encryption_algorithms (
listofstrorNone) –Possible values are:
L3Vpn.IKE_ENCRYPTION_ALGORITHMS__128L3Vpn.IKE_ENCRYPTION_ALGORITHMS__256L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_128L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_192L3Vpn.IKE_ENCRYPTION_ALGORITHMS_GCM_256
Algorithm to be used during Internet Key Exchange(IKE) negotiation. Default is AES_128.
- ike_version (
strorNone) –Possible values are:
IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.
- l3vpn_session (
vmware.vapi.struct.VapiStruct) – L3Vpn Session When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inL3VpnSession. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inL3VpnSession. - local_address (
str) – IPv4 address of local gateway format: ipv4 - passphrases (
listofstrorNone) – List of IPSec pre-shared keys used for IPSec authentication. If not specified, the older passphrase values are retained if there are any. - remote_private_address (
strorNone) – This field is used to resolve conflicts in case of a remote site being behind NAT as remote public ip address is not enough. If it is not the case the remote public address should be provided here. If not provided, the value of this field is set to remote_public_address. - remote_public_address (
str) – Public IPv4 address of remote gateway format: ipv4 - tunnel_digest_algorithms (
listofstrorNone) –Possible values are:
Algorithm to be used for message digest during tunnel establishment. Default algorithm is empty.
- tunnel_encryption_algorithms (
listofstrorNone) –Possible values are:
L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS__128L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS__256L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192L3Vpn.TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256
Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.
-
DH_GROUPS_GROUP14= 'GROUP14'¶
-
DH_GROUPS_GROUP15= 'GROUP15'¶
-
DH_GROUPS_GROUP16= 'GROUP16'¶
-
DH_GROUPS_GROUP2= 'GROUP2'¶
-
DH_GROUPS_GROUP5= 'GROUP5'¶
-
IKE_DIGEST_ALGORITHMS_SHA1= 'SHA1'¶
-
IKE_DIGEST_ALGORITHMS_SHA2_256= 'SHA2_256'¶
-
IKE_ENCRYPTION_ALGORITHMS_128= 'AES_128'¶
-
IKE_ENCRYPTION_ALGORITHMS_256= 'AES_256'¶
-
IKE_ENCRYPTION_ALGORITHMS_GCM_128= 'AES_GCM_128'¶
-
IKE_ENCRYPTION_ALGORITHMS_GCM_192= 'AES_GCM_192'¶
-
IKE_ENCRYPTION_ALGORITHMS_GCM_256= 'AES_GCM_256'¶
-
IKE_VERSION_FLEX= 'IKE_FLEX'¶
-
IKE_VERSION_V1= 'IKE_V1'¶
-
IKE_VERSION_V2= 'IKE_V2'¶
-
TUNNEL_DIGEST_ALGORITHMS_SHA1= 'SHA1'¶
-
TUNNEL_DIGEST_ALGORITHMS_SHA2_256= 'SHA2_256'¶
-
TUNNEL_ENCRYPTION_ALGORITHMS_128= 'AES_128'¶
-
TUNNEL_ENCRYPTION_ALGORITHMS_256= 'AES_256'¶
-
TUNNEL_ENCRYPTION_ALGORITHMS_GCM_128= 'AES_GCM_128'¶
-
TUNNEL_ENCRYPTION_ALGORITHMS_GCM_192= 'AES_GCM_192'¶
-
TUNNEL_ENCRYPTION_ALGORITHMS_GCM_256= 'AES_GCM_256'¶
- links (
-
class
com.vmware.nsx_policy.model_client.L3VpnContext(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, available_local_addresses=None, bypass_rules=None, enabled=None, ike_log_level=None, label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructL3Vpn Context provides the configuration context that different L3Vpns can consume.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - available_local_addresses (
listofPolicyIPAddressInfoorNone) – Local gateway IPv4 addresses available for configuration of each L3Vpn. - bypass_rules (
listofL3VpnRuleorNone) – Bypass L3Vpn rules that will be shared across L3Vpns. Only Bypass action is supported on these L3Vpn rules. - enabled (
boolorNone) – If true, enable L3Vpn Service for given tier-0. Enabling/disabling this service affects all L3Vpns under the given tier-0. - ike_log_level (
strorNone) –Possible values are:
L3VpnContext.IKE_LOG_LEVEL_DEBUGL3VpnContext.IKE_LOG_LEVEL_INFOL3VpnContext.IKE_LOG_LEVEL_WARNL3VpnContext.IKE_LOG_LEVEL_ERRORL3VpnContext.IKE_LOG_LEVEL_EMERGENCY
Log level for internet key exchange (IKE). - label (
strorNone) – Policy path referencing Label. A label is used as a mechanism to group route-based L3Vpns in order to apply edge firewall rules on members’ VTIs.
-
IKE_LOG_LEVEL_DEBUG= 'DEBUG'¶
-
IKE_LOG_LEVEL_EMERGENCY= 'EMERGENCY'¶
-
IKE_LOG_LEVEL_ERROR= 'ERROR'¶
-
IKE_LOG_LEVEL_INFO= 'INFO'¶
-
IKE_LOG_LEVEL_WARN= 'WARN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.L3VpnListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of L3Vpns
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofL3Vpn) – L3Vpn list results
- links (
-
class
com.vmware.nsx_policy.model_client.L3VpnPeerConfigRequestParameters(enforcement_point_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPeer Config Request parameters that represents an enforcement point path. A request to get the Peer config for an L3Vpn can be parameterized with this path and will be evaluted as follows: - no enforcement point path specified: the request is evaluated on all enforcement points. - {enforcement_point_path}: the request is evaluated only on the given enforcement point.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: enforcement_point_path ( strorNone) – enforcement point path, forward slashes must be escaped using %2F.
-
class
com.vmware.nsx_policy.model_client.L3VpnRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destinations=None, sequence_number=None, sources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFor policy-based L3Vpn sessions, a rule specifies as its action the vpn tunnel to be used for transit traffic that meets the rule’s match criteria.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - action (
strorNone) –Possible values are:
Action to exchange data with or without protection. PROTECT - Allows to exchange data with ipsec protection. Protect rules are defined per L3Vpn. BYPASS - Allows to exchange data without ipsec protection. Bypass rules are defined per L3VpnContext and affects all policy based L3Vpns. Bypass rules are prioritized over protect rules.
- destinations (
listofL3VpnSubnet) – List of remote subnets used in policy-based L3Vpn. - sequence_number (
longorNone) – This field is used to resolve conflicts between multiple L3VpnRules associated with a single L3Vpn or L3VpnContext. format: int32 - sources (
listofL3VpnSubnet) – List of local subnets used in policy-based L3Vpn.
-
ACTION_BYPASS= 'BYPASS'¶
-
ACTION_PROTECT= 'PROTECT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.L3VpnSession(resource_type='L3VpnSession')¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains information about L3Vpn session.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSIONL3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION
- A Policy Based L3Vpn is a configuration in which protect rules to
match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.
-
RESOURCE_TYPE_POLICYBASEDL3VPNSESSION= 'PolicyBasedL3VpnSession'¶
-
RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION= 'RouteBasedL3VpnSession'¶
-
class
com.vmware.nsx_policy.model_client.L3VpnStatisticsPerEnforcementPoint(enforcement_point_path=None, resource_type='L3VpnStatisticsPerEnforcementPoint')¶ Bases:
vmware.vapi.bindings.struct.VapiStructL3Vpn Statistics Per Enforcement Point.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enforcement_point_path (
strorNone) – Policy Path referencing the enforcement point wehere the statistics are fetched. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
-
RESOURCE_TYPE_IPSECVPNSESSIONSTATISTICS= 'IPSecVpnSessionStatistics'¶
- enforcement_point_path (
-
class
com.vmware.nsx_policy.model_client.L3VpnSubnet(subnet=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed to specify subnets in L3Vpn rule.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: subnet ( str) – Subnet used in L3Vpn Rule. format: ipv4-cidr-block
-
class
com.vmware.nsx_policy.model_client.L4PortSetNSService(destination_ports=None, l4_protocol=None, source_ports=None, resource_type='L4PortSetNSService')¶ Bases:
vmware.vapi.bindings.struct.VapiStructL4PortSet can be specified in comma separated notation of parts. Parts of a L4PortSet includes single integer or range of port in hyphen notation. Example of a PortSet: "22, 33-70, 44".
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - destination_ports (
listofstrorNone) – Destination ports format: port-or-range - l4_protocol (
str) –Possible values are:
- source_ports (
listofstrorNone) – Source ports format: port-or-range - resource_type (
str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement
-
L4PROTOCOL_TCP= 'TCP'¶
-
L4PROTOCOL_UDP= 'UDP'¶
- destination_ports (
-
class
com.vmware.nsx_policy.model_client.L4PortSetServiceEntry(destination_ports=None, l4_protocol=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L4PortSetServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructL4PortSet can be specified in comma separated notation of parts. Parts of a L4PortSet includes single integer or range of port in hyphen notation. Example of a PortSet: "22, 33-70, 44".
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - destination_ports (
listofstrorNone) – - l4_protocol (
str) –Possible values are:
- source_ports (
listofstrorNone) – - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
L4PROTOCOL_TCP= 'TCP'¶
-
L4PROTOCOL_UDP= 'UDP'¶
- destination_ports (
-
class
com.vmware.nsx_policy.model_client.L7ServiceEntry(destination_ports=None, entity=None, l7_protocol=None, operations=None, source_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='L7ServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceEntry that represents L7 services
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - destination_ports (
listofstrorNone) – - entity (
strorNone) – Example - If REST/HTTP then the entity coulb be a resource URI. - l7_protocol (
str) – - operations (
listofstrorNone) – If the L7 protocol is REST/HTTP then possible operations are PUT, GET, DELETE, etc. - source_ports (
listofstrorNone) – - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- destination_ports (
-
class
com.vmware.nsx_policy.model_client.LBActiveMonitor(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBActiveMonitor', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAll the active types of LBMonitorProfile extend from this abstract class. This is present for extensibility.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- fall_count (
-
class
com.vmware.nsx_policy.model_client.LBAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBAppProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_LBFASTTCPPROFILE= 'LBFastTcpProfile'¶
-
RESOURCE_TYPE_LBFASTUDPPROFILE= 'LBFastUdpProfile'¶
-
RESOURCE_TYPE_LBHTTPPROFILE= 'LBHttpProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBAppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBAppProfile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – LBAppProfile list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBAppProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBAppProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.LBClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - cipher_group_label (
strorNone) –Possible values are:
LBClientSslProfile.CIPHER_GROUP_LABEL_BALANCEDLBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITYLBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITYLBClientSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI.
-
CIPHER_GROUP_LABEL_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABEL_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABEL_HIGH_SECURITY= 'HIGH_SECURITY'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBClientSslProfileBinding(default_certificate_path=None, sni_certificate_paths=None, ssl_profile_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - default_certificate_path (
str) – A default certificate should be specified which will be used if the server does not host multiple hostnames on the same IP address or if the client does not support SNI extension. - sni_certificate_paths (
listofstrorNone) – Client-side SSL profile binding allows multiple certificates, for different hostnames, to be bound to the same virtual server. - ssl_profile_path (
strorNone) – Client SSL profile defines reusable, application-independent client side SSL properties.
- default_certificate_path (
-
class
com.vmware.nsx_policy.model_client.LBClientSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLBClientSslProfile) – paginated list of load balancer client SSL profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LBCookiePersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBCookiePersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSome applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - persistence_shared (
boolorNone) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.
- links (
-
class
com.vmware.nsx_policy.model_client.LBFastTcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastTcpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LBFastUdpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBFastUdpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LBHttpMonitorProfile(request_url=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - request_url (
strorNone) – For HTTP active healthchecks, the HTTP request url sent can be customized and can include query parameters. - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- request_url (
-
class
com.vmware.nsx_policy.model_client.LBHttpProfile(x_forwarded_for=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBHttpProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - x_forwarded_for (
strorNone) –Possible values are:
insert or replace x_forwarded_for - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBAppProfile.RESOURCE_TYPE_LBHTTPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELBAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile. LBFastTCPProfile or LBFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LBHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LBHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
XFORWARDED_FOR_INSERT= 'INSERT'¶
- x_forwarded_for (
-
class
com.vmware.nsx_policy.model_client.LBHttpRequestHeaderCondition(header_value=None, type='LBHttpRequestHeaderCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match HTTP request messages by the specific HTTP header field, Host. The Host request header specifies the domain name of the server. The supplied Host HTTP header match condition will be matched as a regular expression. The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator’s Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character (\) needs to be escaped by one additional backslash character.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_value (
str) – Value of HTTP header - type (
str) –Possible values are:
Type of load balancer rule condition
- header_value (
-
class
com.vmware.nsx_policy.model_client.LBHttpRequestUriCondition(uri=None, type='LBHttpRequestUriCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regluar expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. The path_match field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has "/image/" or "/images/", uri field can be specified as: "/image[s]?/". The regular expressions in load balancer rules use the features common to both Java regular expressions and Perl Compatible Regular Expressions (PCREs) with some restrictions. Reference http://www.pcre .org for PCRE and the NSX-T Administrator’s Guide for the restrictions. Please note, when regular expressions are used in JSON (JavaScript Object Notation) string, every backslash character (\) needs to be escaped by one additional backslash character.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - uri (
str) – A string used to identify resource - type (
str) –Possible values are:
Type of load balancer rule condition
- uri (
-
class
com.vmware.nsx_policy.model_client.LBHttpsMonitorProfile(request_url=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - request_url (
strorNone) – For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters. - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- request_url (
-
class
com.vmware.nsx_policy.model_client.LBIcmpMonitorProfile(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over ICMP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healt hchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- fall_count (
-
class
com.vmware.nsx_policy.model_client.LBMonitorProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBMonitorProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_LBHTTPMONITORPROFILE= 'LBHttpMonitorProfile'¶
-
RESOURCE_TYPE_LBHTTPSMONITORPROFILE= 'LBHttpsMonitorProfile'¶
-
RESOURCE_TYPE_LBICMPMONITORPROFILE= 'LBIcmpMonitorProfile'¶
-
RESOURCE_TYPE_LBTCPMONITORPROFILE= 'LBTcpMonitorProfile'¶
-
RESOURCE_TYPE_LBUDPMONITORPROFILE= 'LBUdpMonitorProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBMonitorProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBMonitorProfiles
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – LBMonitorProfile list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBMonitorProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBMonitorProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.LBPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSome applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - persistence_shared (
boolorNone) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.
-
RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE= 'LBCookiePersistenceProfile'¶
-
RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE= 'LBSourceIpPersistenceProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBPersistenceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBPersistenceProfiles
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – LBPersistenceProfile list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBPersistenceProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBPersistenceProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.LBPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, active_monitor_paths=None, algorithm=None, member_group=None, members=None, snat_translation=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDefining access of a Group from a LBVirtualServer and binding to LBMonitorProfile.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - active_monitor_paths (
listofstrorNone) – In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. Currently, only one active health monitor can be configured per server pool. - algorithm (
strorNone) –Possible values are:
Load balanding algorithm controls how the incoming connections are distributed among the members. - ROUND_ROBIN - requests to the application servers are distributed in a round-robin fashion, - LEAST_CONNECTION - next request is assigned to the server with the least number of active connections
- member_group (
LBPoolMemberGrouporNone) – Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified. - members (
listofLBPoolMemberorNone) – Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. - snat_translation (
vmware.vapi.struct.VapiStructorNone) – Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. By default Source NAT is enabled as LBSnatAutoMap. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBSnatTranslation. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBSnatTranslation.
-
ALGORITHM_LEAST_CONNECTION= 'LEAST_CONNECTION'¶
-
ALGORITHM_ROUND_ROBIN= 'ROUND_ROBIN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBPool
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLBPool) – LBPool list results
- links (
-
class
com.vmware.nsx_policy.model_client.LBPoolMember(display_name=None, ip_address=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
strorNone) – pool member name - ip_address (
str) – pool member IP address format: ip - port (
strorNone) – If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case. format: port-or-range
- display_name (
-
class
com.vmware.nsx_policy.model_client.LBPoolMemberGroup(group_path=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - group_path (
str) – Load balancer pool support Group as dynamic pool members. The IP list of the Group would be used as pool member IP setting. - port (
longorNone) – If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case. format: int32
- group_path (
-
class
com.vmware.nsx_policy.model_client.LBRule(actions=None, display_name=None, match_conditions=None, match_strategy=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBinding of a LBPool and Group to a LBVirtualServer used to route application traffic passing through load balancers. LBRule uses match conditions to match application traffic passing through a LBVirtualServer using HTTP or HTTPS. Can bind multiple LBVirtualServers to a Group. Each LBRule consists of two optional match conditions, each match contidion defines a criterion for application traffic. If no match conditions are specified, then the LBRule will always match and it is used typically to define default rules. If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LBRule to be considered a match. A match indicates that the LBVirtualServer should route the request to the Group (parent of LBRule).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - actions (
listofvmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBRuleAction. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBRuleAction. - display_name (
strorNone) – A display name useful for identifying an LbRule - match_conditions (
listofvmware.vapi.struct.VapiStructorNone) – A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLBRuleCondition. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLBRuleCondition. - match_strategy (
strorNone) –Possible values are:
If more than one match condition is specified, then matching strategy determines if all conditions should match or any one condition should match for the LB Rule to be considered a match. - ALL indicates that both host_match and path_match must match for this LBRule to be considered a match - ANY indicates that either host_match or patch match may match for this LBRule to be considered a match
-
MATCH_STRATEGY_ALL= 'ALL'¶
-
MATCH_STRATEGY_ANY= 'ANY'¶
- actions (
-
class
com.vmware.nsx_policy.model_client.LBRuleAction(type='LBRuleAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer rule actions are used to manipulate application traffic. Supported actions are LBSelectPoolAction
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Type of load balancer rule action-
TYPE_LBSELECTPOOLACTION= 'LBSelectPoolAction'¶
-
-
class
com.vmware.nsx_policy.model_client.LBRuleCondition(type='LBRuleCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructMatch conditions are used to match application traffic passing through load balancers. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion for application traffic. If more than one match condition is specified, match strategy determines if all conditions should match or any one condition should match for the load balancer rule to be considered a match.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Type of load balancer rule condition-
TYPE_LBHTTPREQUESTHEADERCONDITION= 'LBHttpRequestHeaderCondition'¶
-
TYPE_LBHTTPREQUESTURICONDITION= 'LBHttpRequestUriCondition'¶
-
-
class
com.vmware.nsx_policy.model_client.LBSelectPoolAction(pool_id=None, type='LBSelectPoolAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to select a pool for matched HTTP request messages. The pool is specified by path. The matched HTTP request messages are forwarded to the specified pool.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - pool_id (
str) – path of load balancer pool - type (
str) –Possible values are:
Type of load balancer rule action
- pool_id (
-
class
com.vmware.nsx_policy.model_client.LBServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, cipher_group_label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - cipher_group_label (
strorNone) –Possible values are:
LBServerSslProfile.CIPHER_GROUP_LABEL_BALANCEDLBServerSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITYLBServerSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITYLBServerSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI.
-
CIPHER_GROUP_LABEL_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABEL_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABEL_HIGH_SECURITY= 'HIGH_SECURITY'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBServerSslProfileBinding(server_auth_ca_paths=None, ssl_profile_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - server_auth_ca_paths (
listofstrorNone) – If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. - ssl_profile_path (
strorNone) – Server SSL profile defines reusable, application-independent server side SSL properties.
- server_auth_ca_paths (
-
class
com.vmware.nsx_policy.model_client.LBServerSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLBServerSslProfile) – paginated list of load balancer server SSL profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LBService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, connectivity_path=None, enabled=None, error_log_level=None, size=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - access_log_enabled (
boolorNone) – whether access log is enabled - connectivity_path (
strorNone) – LBS could be instantiated (or created) on Tier-1, etc. For now, only Tier-1 object is supported. - enabled (
boolorNone) – whether the load balancer service is enabled - error_log_level (
strorNone) –Possible values are:
LBService.ERROR_LOG_LEVEL_DEBUGLBService.ERROR_LOG_LEVEL_INFOLBService.ERROR_LOG_LEVEL_WARNINGLBService.ERROR_LOG_LEVEL_ERRORLBService.ERROR_LOG_LEVEL_CRITICALLBService.ERROR_LOG_LEVEL_ALERTLBService.ERROR_LOG_LEVEL_EMERGENCY
Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
- size (
strorNone) –Possible values are:
the size of load balancer service
-
ERROR_LOG_LEVEL_ALERT= 'ALERT'¶
-
ERROR_LOG_LEVEL_CRITICAL= 'CRITICAL'¶
-
ERROR_LOG_LEVEL_DEBUG= 'DEBUG'¶
-
ERROR_LOG_LEVEL_EMERGENCY= 'EMERGENCY'¶
-
ERROR_LOG_LEVEL_ERROR= 'ERROR'¶
-
ERROR_LOG_LEVEL_INFO= 'INFO'¶
-
ERROR_LOG_LEVEL_WARNING= 'WARNING'¶
-
SIZE_LARGE= 'LARGE'¶
-
SIZE_MEDIUM= 'MEDIUM'¶
-
SIZE_SMALL= 'SMALL'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LBServiceElement(element_id=None, elements=None, resource_name=None, resource_type=None, active_edge_tns=None, attached_router_id=None, runtime_status=None, size=None, standby_edge_tns=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad Balancer service element, contains information about LoadBalancer Service on an edge.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofLBVirtualServerElementorNone) – Array of elements This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
LBServiceElement.RESOURCE_TYPE_VMELEMENTLBServiceElement.RESOURCE_TYPE_GROUPELEMENTLBServiceElement.RESOURCE_TYPE_PROCESSELEMENTLBServiceElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTLBServiceElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTLBServiceElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTLBServiceElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTLBServiceElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTLBServiceElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTLBServiceElement.RESOURCE_TYPE_HOSTNODEELEMENTLBServiceElement.RESOURCE_TYPE_EDGENODEELEMENTLBServiceElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTLBServiceElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element - active_edge_tns (
listofstrorNone) – Active Edge TransportNode IDs This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - attached_router_id (
strorNone) – The logical router to which this loadbalancer service is attached. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - runtime_status (
strorNone) –Possible values are:
LBServiceElement.RUNTIME_STATUS_UPLBServiceElement.RUNTIME_STATUS_DOWNLBServiceElement.RUNTIME_STATUS_ERRORLBServiceElement.RUNTIME_STATUS_NO_STANDBYLBServiceElement.RUNTIME_STATUS_DETACHEDLBServiceElement.RUNTIME_STATUS_DISABLEDLBServiceElement.RUNTIME_STATUS_UNKNOWN
LoadBalancer runtime statusThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- size (
strorNone) –Possible values are:
LoadBalancer size when deployed on the edge nodeThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- standby_edge_tns (
listofstrorNone) – Standby Edge TransportNode IDs This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
RUNTIME_STATUS_DETACHED= 'DETACHED'¶
-
RUNTIME_STATUS_DISABLED= 'DISABLED'¶
-
RUNTIME_STATUS_DOWN= 'DOWN'¶
-
RUNTIME_STATUS_ERROR= 'ERROR'¶
-
RUNTIME_STATUS_NO_STANDBY= 'NO_STANDBY'¶
-
RUNTIME_STATUS_UNKNOWN= 'UNKNOWN'¶
-
RUNTIME_STATUS_UP= 'UP'¶
-
SIZE_LARGE= 'LARGE'¶
-
SIZE_MEDIUM= 'MEDIUM'¶
-
SIZE_SMALL= 'SMALL'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.LBServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBServices
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLBService) – LBService list results
- links (
-
class
com.vmware.nsx_policy.model_client.LBSnatAutoMap(type='LBSnatAutoMap')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LBSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LBSnatDisabled disbles Source NAT. This is referred to as no-SNAT or TRANSPARENT mode.
-
class
com.vmware.nsx_policy.model_client.LBSnatDisabled(type='LBSnatDisabled')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LBSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LBSnatDisabled disbles Source NAT. This is referred to as no-SNAT or TRANSPARENT mode.
-
class
com.vmware.nsx_policy.model_client.LBSnatInfo(port_overload=None, snat_mode=None, source_ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer Virtual server pool Source Network Address Translation (SNAT) information
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - port_overload (
longorNone) – Port to apply for source port during SNAT. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - snat_mode (
strorNone) –Possible values are:
SNAT mode configured.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- source_ip_addresses (
listofstrorNone) – Source ip addresses to use during SNAT. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SNAT_MODE_AUTO_MAP= 'AUTO_MAP'¶
-
SNAT_MODE_IP_LIST= 'IP_LIST'¶
-
SNAT_MODE_TRANSPARENT= 'TRANSPARENT'¶
- port_overload (
-
class
com.vmware.nsx_policy.model_client.LBSnatTranslation(type='LBSnatTranslation')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LBSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LBSnatDisabled disbles Source NAT. This is referred to as no-SNAT or TRANSPARENT mode.
-
TYPE_LBSNATAUTOMAP= 'LBSnatAutoMap'¶
-
TYPE_LBSNATDISABLED= 'LBSnatDisabled'¶
-
-
class
com.vmware.nsx_policy.model_client.LBSourceIpPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LBSourceIpPersistenceProfile', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSome applications maintain state and require all relevant connections to be sent to the same server as the application state is not synchronized among servers. Persistence is enabled on a LBVirtualServer by binding a persistence profile to it.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - persistence_shared (
boolorNone) – Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client’s connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistenct type, the persistence table will be shared across virtual servers.
- links (
-
class
com.vmware.nsx_policy.model_client.LBSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer abstract SSL profile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LBTcpMonitorProfile(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over TCP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- fall_count (
-
class
com.vmware.nsx_policy.model_client.LBUdpMonitorProfile(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructActive healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over UDP. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - receive (
str) – Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period. - send (
str) – The data to be sent to the monitored server. - fall_count (
longorNone) – Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64 - interval (
longorNone) – Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64 - monitor_port (
longorNone) – Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. format: int32 - rise_count (
longorNone) – Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64 - timeout (
longorNone) – Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILELBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE
Load balancers monitor the health of backend servers to ensure traffic is not black holed. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- receive (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, access_log_enabled=None, application_profile_path=None, client_ssl_profile_binding=None, ip_address=None, lb_persistence_profile_path=None, lb_service_path=None, pool_path=None, ports=None, rules=None, server_ssl_profile_binding=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAll the types of LBVirtualServer extend from this abstract class. This is present for extensibility.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - access_log_enabled (
boolorNone) – If access log is enabled, all HTTP requests sent to an L7 virtual server are logged to the access log file. Both successful requests (backend server returns 2xx) and unsuccessful requests (backend server returns 4xx or 5xx) are logged to access log, if enabled. - application_profile_path (
str) – The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported. - client_ssl_profile_binding (
LBClientSslProfileBindingorNone) – The setting is used when load balancer acts as an SSL server and terminating the client SSL connection - ip_address (
str) – Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip - lb_persistence_profile_path (
strorNone) – Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is disabled by default. - lb_service_path (
strorNone) – virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), Lb virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities. - pool_path (
strorNone) – The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application. - ports (
listofstr) – Ports contains a list of at least one port or port range such as "80", "1234-1236". Each port element in the list should be a single port or a single port range. format: port-or-range - rules (
listofLBRuleorNone) – Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile. - server_ssl_profile_binding (
LBServerSslProfileBindingorNone) – The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server.
- links (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerElement(element_id=None, elements=None, resource_name=None, resource_type=None, runtime_status=None, server_ip=None, server_pool=None, server_port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad Balancer virtual server element information. It contains information about the virtual server ip and the server pool.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
LBVirtualServerElement.RESOURCE_TYPE_VMELEMENTLBVirtualServerElement.RESOURCE_TYPE_GROUPELEMENTLBVirtualServerElement.RESOURCE_TYPE_PROCESSELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTLBVirtualServerElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTLBVirtualServerElement.RESOURCE_TYPE_HOSTNODEELEMENTLBVirtualServerElement.RESOURCE_TYPE_EDGENODEELEMENTLBVirtualServerElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTResource type of the element
- runtime_status (
strorNone) –Possible values are:
LBVirtualServerElement.RUNTIME_STATUS_UPLBVirtualServerElement.RUNTIME_STATUS_PARTIALLY_UPLBVirtualServerElement.RUNTIME_STATUS_PARTIALLY_DOWNLBVirtualServerElement.RUNTIME_STATUS_DOWNLBVirtualServerElement.RUNTIME_STATUS_DETACHEDLBVirtualServerElement.RUNTIME_STATUS_DISABLED
Virtual server runtime statusThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- server_ip (
strorNone) – Virtual Server IP of the LB virtual server format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - server_pool (
LBVirtualServerPoolorNone) – Virtual server pool info. - server_port (
longorNone) – Virtual Server port of the LB virtual server. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
RUNTIME_STATUS_DETACHED= 'DETACHED'¶
-
RUNTIME_STATUS_DISABLED= 'DISABLED'¶
-
RUNTIME_STATUS_DOWN= 'DOWN'¶
-
RUNTIME_STATUS_PARTIALLY_DOWN= 'PARTIALLY_DOWN'¶
-
RUNTIME_STATUS_PARTIALLY_UP= 'PARTIALLY_UP'¶
-
RUNTIME_STATUS_UP= 'UP'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerIpSetNsGroupMembers(members=None, membership_type=None, ns_group_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual server pool members based on NsGruop of IPSet.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - members (
listofLBVirtualServerPoolMemberorNone) – A load balancer’s virtual server pool members list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - membership_type (
strorNone) –Possible values are:
LBVirtualServerIpSetNsGroupMembers.MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERSLBVirtualServerIpSetNsGroupMembers.MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS
Server pool membership type. Static or NsGroups are supported membership types. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ns_group_id (
strorNone) – Membership of Loabalancer virtual server pool specified using NsGroup of IPSets. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS= 'LBVirtualServerIpSetNsGroupMembers'¶
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS= 'LBVirtualServerPoolStaticMembers'¶
- members (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of LBVirtualServers
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLBVirtualServer) – LBVirtualServer list results
- links (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerPool(pool_members_info=None, server_pool_algorithm=None, snat_info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual server pool information in a load balancer
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - pool_members_info (
LBVirtualServerPoolMembersInfoorNone) – LB Virtual server pool membership info - server_pool_algorithm (
strorNone) –Possible values are:
LBVirtualServerPool.SERVER_POOL_ALGORITHM_ROUND_ROBINLBVirtualServerPool.SERVER_POOL_ALGORITHM_WEIGHTED_ROUND_ROBINLBVirtualServerPool.SERVER_POOL_ALGORITHM_LEAST_CONNECTIONLBVirtualServerPool.SERVER_POOL_ALGORITHM_WEIGHTED_LEAST_CONNECTIONLBVirtualServerPool.SERVER_POOL_ALGORITHM_IP_HASH
Loadbalancer algorithm configured for this virtual server pool.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- snat_info (
LBSnatInfoorNone) – SNAT configuration info for this server pool.
-
SERVER_POOL_ALGORITHM_IP_HASH= 'IP_HASH'¶
-
SERVER_POOL_ALGORITHM_LEAST_CONNECTION= 'LEAST_CONNECTION'¶
-
SERVER_POOL_ALGORITHM_ROUND_ROBIN= 'ROUND_ROBIN'¶
-
SERVER_POOL_ALGORITHM_WEIGHTED_LEAST_CONNECTION= 'WEIGHTED_LEAST_CONNECTION'¶
-
SERVER_POOL_ALGORITHM_WEIGHTED_ROUND_ROBIN= 'WEIGHTED_ROUND_ROBIN'¶
- pool_members_info (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerPoolMember(ip=None, member_status=None, name=None, port=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual server pool members information.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip (
strorNone) – IP address of the server pool member. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - member_status (
strorNone) –Possible values are:
LBVirtualServerPoolMember.MEMBER_STATUS_UPLBVirtualServerPoolMember.MEMBER_STATUS_DOWNLBVirtualServerPoolMember.MEMBER_STATUS_DISABLEDLBVirtualServerPoolMember.MEMBER_STATUS_UNKNOWN
Server pool member runtime status - name (
strorNone) – Name of the virtual server pool member This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - port (
longorNone) – Port on which this server pool member is listening. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - weight (
longorNone) – Weight of this server pool member. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MEMBER_STATUS_DISABLED= 'DISABLED'¶
-
MEMBER_STATUS_DOWN= 'DOWN'¶
-
MEMBER_STATUS_UNKNOWN= 'UNKNOWN'¶
-
MEMBER_STATUS_UP= 'UP'¶
- ip (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerPoolMembersInfo(members=None, membership_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual server pool members information.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - members (
listofLBVirtualServerPoolMemberorNone) – A load balancer’s virtual server pool members list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - membership_type (
strorNone) –Possible values are:
LBVirtualServerPoolMembersInfo.MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERSLBVirtualServerPoolMembersInfo.MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS
Server pool membership type. Static or NsGroups are supported membership types. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS= 'LBVirtualServerIpSetNsGroupMembers'¶
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS= 'LBVirtualServerPoolStaticMembers'¶
- members (
-
class
com.vmware.nsx_policy.model_client.LBVirtualServerPoolStaticMembers(members=None, membership_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual server pool static members.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - members (
listofLBVirtualServerPoolMemberorNone) – A load balancer’s virtual server pool members list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - membership_type (
strorNone) –Possible values are:
LBVirtualServerPoolStaticMembers.MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERSLBVirtualServerPoolStaticMembers.MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS
Server pool membership type. Static or NsGroups are supported membership types. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERIPSETNSGROUPMEMBERS= 'LBVirtualServerIpSetNsGroupMembers'¶
-
MEMBERSHIP_TYPE_LBVIRTUALSERVERPOOLSTATICMEMBERS= 'LBVirtualServerPoolStaticMembers'¶
- members (
-
class
com.vmware.nsx_policy.model_client.Label(condition=None, hover=None, icons=None, navigation=None, text=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLabel that will be displayed for a UI element.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - condition (
strorNone) – If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API. - hover (
boolorNone) – If true, displays the label only on hover - icons (
listofIconorNone) – Icons to be applied at dashboard for the label - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - text (
str) – Text to be displayed at the label.
- condition (
-
class
com.vmware.nsx_policy.model_client.LabelValueConfiguration(navigation=None, properties=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LabelValueConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a Label-Value widget configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - properties (
listofPropertyItem) – An array of label-value properties. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- navigation (
-
class
com.vmware.nsx_policy.model_client.Lag(id=None, load_balance_algorithm=None, mode=None, name=None, number_of_uplinks=None, timeout_type=None, uplinks=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLACP group
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - id (
strorNone) – unique id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - load_balance_algorithm (
str) –Possible values are:
Lag.LOAD_BALANCE_ALGORITHM_SRCMACLag.LOAD_BALANCE_ALGORITHM_DESTMACLag.LOAD_BALANCE_ALGORITHM_SRCDESTMACLag.LOAD_BALANCE_ALGORITHM_SRCDESTIPVLANLag.LOAD_BALANCE_ALGORITHM_SRCDESTMACIPPORT
LACP load balance Algorithm - mode (
str) –Possible values are:
LACP group mode - name (
str) – Lag name - number_of_uplinks (
long) – number of uplinks format: int32 - timeout_type (
strorNone) –Possible values are:
LACP timeout type - uplinks (
listofUplinkorNone) – uplink names This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
LOAD_BALANCE_ALGORITHM_DESTMAC= 'DESTMAC'¶
-
LOAD_BALANCE_ALGORITHM_SRCDESTIPVLAN= 'SRCDESTIPVLAN'¶
-
LOAD_BALANCE_ALGORITHM_SRCDESTMAC= 'SRCDESTMAC'¶
-
LOAD_BALANCE_ALGORITHM_SRCDESTMACIPPORT= 'SRCDESTMACIPPORT'¶
-
LOAD_BALANCE_ALGORITHM_SRCMAC= 'SRCMAC'¶
-
MODE_ACTIVE= 'ACTIVE'¶
-
MODE_PASSIVE= 'PASSIVE'¶
-
TIMEOUT_TYPE_FAST= 'FAST'¶
-
TIMEOUT_TYPE_SLOW= 'SLOW'¶
- id (
-
class
com.vmware.nsx_policy.model_client.LbActiveMonitor(fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbActiveMonitor', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- fall_count (
-
class
com.vmware.nsx_policy.model_client.LbAppProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbAppProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbAppProfile.RESOURCE_TYPE_LBHTTPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or LbFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LbHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LbHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_LBFASTTCPPROFILE= 'LbFastTcpProfile'¶
-
RESOURCE_TYPE_LBFASTUDPPROFILE= 'LbFastUdpProfile'¶
-
RESOURCE_TYPE_LBHTTPPROFILE= 'LbHttpProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbAppProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – paginated list of load balancer application profiles When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbAppProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbAppProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.LbClientCertificateIssuerDnCondition(case_sensitive=None, issuer_dn=None, match_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMatch condition for client certficate issuer DN
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - case_sensitive (
boolorNone) – If true, case is significant when comparing issuer DN value. - issuer_dn (
str) – Value of issuer DN - match_type (
strorNone) –Possible values are:
LbClientCertificateIssuerDnCondition.MATCH_TYPE_STARTS_WITHLbClientCertificateIssuerDnCondition.MATCH_TYPE_ENDS_WITHLbClientCertificateIssuerDnCondition.MATCH_TYPE_EQUALSLbClientCertificateIssuerDnCondition.MATCH_TYPE_CONTAINSLbClientCertificateIssuerDnCondition.MATCH_TYPE_REGEX
Match type of issuer DN
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
- case_sensitive (
-
class
com.vmware.nsx_policy.model_client.LbClientCertificateSubjectDnCondition(case_sensitive=None, match_type=None, subject_dn=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMatch condition for client certficate subject DN
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - case_sensitive (
boolorNone) – If true, case is significant when comparing subject DN value. - match_type (
strorNone) –Possible values are:
LbClientCertificateSubjectDnCondition.MATCH_TYPE_STARTS_WITHLbClientCertificateSubjectDnCondition.MATCH_TYPE_ENDS_WITHLbClientCertificateSubjectDnCondition.MATCH_TYPE_EQUALSLbClientCertificateSubjectDnCondition.MATCH_TYPE_CONTAINSLbClientCertificateSubjectDnCondition.MATCH_TYPE_REGEX
Match type of subject DN - subject_dn (
str) – Value of subject DN
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
- case_sensitive (
-
class
com.vmware.nsx_policy.model_client.LbClientSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, prefer_server_ciphers=None, protocols=None, session_cache_enabled=None, session_cache_timeout=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cipher_group_label (
strorNone) –Possible values are:
LbClientSslProfile.CIPHER_GROUP_LABEL_BALANCEDLbClientSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITYLbClientSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITYLbClientSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI. - ciphers (
listofstrorNone) –Possible values are:
LbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256LbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384LbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHALbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHALbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHALbClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHALbClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHALbClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHALbClientSslProfile.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHALbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHALbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256LbClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384LbClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA256LbClientSslProfile.CIPHERS_RSA_WITH_AES_128_GCM_SHA256LbClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA256LbClientSslProfile.CIPHERS_RSA_WITH_AES_256_GCM_SHA384LbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHALbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256LbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256LbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384LbClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384LbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHALbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256LbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256LbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384LbClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384LbClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHALbClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256LbClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256LbClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384supported SSL cipher list to client side
- is_fips (
boolorNone) – This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_secure (
boolorNone) – This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - prefer_server_ciphers (
boolorNone) – During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client’s preference. - protocols (
listofstrorNone) –Possible values are:
LbClientSslProfile.PROTOCOLS_SSL_V2LbClientSslProfile.PROTOCOLS_SSL_V3LbClientSslProfile.PROTOCOLS_TLS_V1LbClientSslProfile.PROTOCOLS_TLS_V1_1LbClientSslProfile.PROTOCOLS_TLS_V1_2
SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
- session_cache_enabled (
boolorNone) – SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake. - session_cache_timeout (
longorNone) – Session cache timeout specifies how long the SSL session parameters are held on to and can be reused. format: int64
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_GROUP_LABEL_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABEL_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABEL_HIGH_SECURITY= 'HIGH_SECURITY'¶
-
PROTOCOLS_SSL_V2= 'SSL_V2'¶
-
PROTOCOLS_SSL_V3= 'SSL_V3'¶
-
PROTOCOLS_TLS_V1= 'TLS_V1'¶
-
PROTOCOLS_TLS_V1_1= 'TLS_V1_1'¶
-
PROTOCOLS_TLS_V1_2= 'TLS_V1_2'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbClientSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbClientSslProfile) – paginated list of load balancer client SSL profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LbCookiePersistenceProfile(cookie_domain=None, cookie_fallback=None, cookie_garble=None, cookie_mode=None, cookie_name=None, cookie_path=None, cookie_time=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbCookiePersistenceProfile', tags=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cookie_domain (
strorNone) – HTTP cookie domain could be configured, only available for insert mode. - cookie_fallback (
boolorNone) – If fallback is true, once the cookie points to a server that is down (i.e. admin state DISABLED or healthcheck state is DOWN), then a new server is selected by default to handle that request. If fallback is false, it will cause the request to be rejected if cookie points to a server - cookie_garble (
boolorNone) – If garble is set to true, cookie value (server IP and port) would be encrypted. If garble is set to false, cookie value would be plain text. - cookie_mode (
strorNone) –Possible values are:
LbCookiePersistenceProfile.COOKIE_MODE_INSERTLbCookiePersistenceProfile.COOKIE_MODE_PREFIXLbCookiePersistenceProfile.COOKIE_MODE_REWRITE
cookie persistence mode - cookie_name (
str) – cookie name - cookie_path (
strorNone) – HTTP cookie path could be set, only available for insert mode. - cookie_time (
vmware.vapi.struct.VapiStructorNone) – Both session cookie and persistence cookie are supported, if not specified, it’s a session cookie. It expires when the browser is closed. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbCookieTime. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbCookieTime. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILELbPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
Source-ip persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. Cookie persistence allows related client connections, identified by the same cookie in HTTP requests, to be redirected to the same server.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - persistence_shared (
boolorNone) – If persistence shared flag is not set in the cookie persistence profile bound to a virtual server, it defaults to cookie persistence that is private to each virtual server and is qualified by the pool. This is accomplished by load balancer inserting a cookie with name in the format <name>.<virtual_server_id>.<pool_id>. If persistence shared flag is set in the cookie persistence profile, in cookie insert mode, cookie persistence could be shared across multiple virtual servers that are bound to the same pools. The cookie name would be changed to <name>.<profile-id>.<pool-id>. If persistence shared flag is not set in the sourceIp persistence profile bound to a virtual server, each virtual server that the profile is bound to maintains its own private persistence table. If persistence shared flag is set in the sourceIp persistence profile, all virtual servers the profile is bound to share the same persistence table.
-
COOKIE_MODE_INSERT= 'INSERT'¶
-
COOKIE_MODE_PREFIX= 'PREFIX'¶
-
COOKIE_MODE_REWRITE= 'REWRITE'¶
- cookie_domain (
-
class
com.vmware.nsx_policy.model_client.LbCookieTime(type='LbCookieTime')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: type ( str) –Possible values are:
Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting
-
TYPE_LBPERSISTENCECOOKIETIME= 'LbPersistenceCookieTime'¶
-
TYPE_LBSESSIONCOOKIETIME= 'LbSessionCookieTime'¶
-
-
class
com.vmware.nsx_policy.model_client.LbFastTcpProfile(close_timeout=None, ha_flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbFastTcpProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - close_timeout (
longorNone) – It is used to specify how long a closing TCP connection (both FINs received or a RST is received) should be kept for this application before cleaning up the connection. format: int64 - ha_flow_mirroring_enabled (
boolorNone) – If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node. - idle_timeout (
longorNone) – It is used to configure how long an idle TCP connection in ESTABLISHED state should be kept for this application before cleaning up. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbAppProfile.RESOURCE_TYPE_LBHTTPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or LbFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LbHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LbHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- close_timeout (
-
class
com.vmware.nsx_policy.model_client.LbFastUdpProfile(flow_mirroring_enabled=None, idle_timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbFastUdpProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - flow_mirroring_enabled (
boolorNone) – If flow mirroring is enabled, all the flows to the bounded virtual server are mirrored to the standby node. - idle_timeout (
longorNone) – Though UDP is a connectionless protocol, for the purposes of load balancing, all UDP packets with the same flow signature (source and destination IP/ports and IP protocol) received within the idle timeout period are considered to belong to the same connection and are sent to the same backend server. If no packets are received for idle timeout period, the connection (association between flow signature and the selected server) is cleaned up. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbAppProfile.RESOURCE_TYPE_LBHTTPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or LbFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LbHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LbHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- flow_mirroring_enabled (
-
class
com.vmware.nsx_policy.model_client.LbHttpMonitor(request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - request_body (
strorNone) – String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST. - request_headers (
listofLbHttpRequestHeaderorNone) – Array of HTTP request headers - request_method (
strorNone) –Possible values are:
LbHttpMonitor.REQUEST_METHOD_GETLbHttpMonitor.REQUEST_METHOD_OPTIONSLbHttpMonitor.REQUEST_METHOD_POSTLbHttpMonitor.REQUEST_METHOD_HEADLbHttpMonitor.REQUEST_METHOD_PUT
the health check method for HTTP monitor type - request_url (
strorNone) – URL used for HTTP monitor - request_version (
strorNone) –Possible values are:
LbHttpMonitor.REQUEST_VERSION__1_0LbHttpMonitor.REQUEST_VERSION__1_1LbHttpMonitor.REQUEST_VERSION__2_0
HTTP request version - response_body (
strorNone) – If HTTP response body match string (regular expressions not supported) is specified (using LbHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful. - response_status_codes (
listoflongorNone) – The HTTP response status code should be a valid HTTP status code. format: int32 - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
REQUEST_METHOD_GET= 'GET'¶
-
REQUEST_METHOD_HEAD= 'HEAD'¶
-
REQUEST_METHOD_OPTIONS= 'OPTIONS'¶
-
REQUEST_METHOD_POST= 'POST'¶
-
REQUEST_METHOD_PUT= 'PUT'¶
-
REQUEST_VERSION_1_0= 'HTTP_VERSION_1_0'¶
-
REQUEST_VERSION_1_1= 'HTTP_VERSION_1_1'¶
-
REQUEST_VERSION_2_0= 'HTTP_VERSION_2_0'¶
- request_body (
-
class
com.vmware.nsx_policy.model_client.LbHttpProfile(http_redirect_to=None, http_redirect_to_https=None, idle_timeout=None, ntlm=None, request_body_size=None, request_header_size=None, response_timeout=None, x_forwarded_for=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbHttpProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - http_redirect_to (
strorNone) – If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL - http_redirect_to_https (
boolorNone) – Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL. - idle_timeout (
longorNone) – It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request. It is not a TCP socket setting. format: int64 - ntlm (
boolorNone) – NTLM is an authentication protocol that can be used over HTTP. If the flag is set to true, LB will use NTLM challenge/response methodology. - request_body_size (
longorNone) – If it is not specified, it means that request body size is unlimited. format: int64 - request_header_size (
longorNone) – A request with header larger than request_header_size will be processed as best effort whereas a request with header below this specified size is guaranteed to be processed. format: int64 - response_timeout (
longorNone) – If server doesn’t send any packet within this time, the connection is closed. format: int64 - x_forwarded_for (
strorNone) –Possible values are:
insert or replace x_forwarded_for - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbAppProfile.RESOURCE_TYPE_LBHTTPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTTCPPROFILELbAppProfile.RESOURCE_TYPE_LBFASTUDPPROFILE
An application profile can be bound to a virtual server to specify the application protocol characteristics. It is used to influence how load balancing is performed. Currently, three types of application profiles are supported: LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile. LbFastTCPProfile or LbFastUDPProfile is typically used when the application is using a custom protocol or a standard protocol not supported by the load balancer. It is also used in cases where the user only wants L4 load balancing mainly because L4 load balancing has much higher performance and scalability, and/or supports connection mirroring. LbHttpProfile is used for both HTTP and HTTPS applications. Though application rules, if bound to the virtual server, can be used to accomplish the same goal, LbHttpProfile is intended to simplify enabling certain common use cases.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
XFORWARDED_FOR_INSERT= 'INSERT'¶
-
XFORWARDED_FOR_REPLACE= 'REPLACE'¶
- http_redirect_to (
-
class
com.vmware.nsx_policy.model_client.LbHttpRedirectAction(redirect_status=None, redirect_url=None, type='LbHttpRedirectAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to redirect HTTP request messages to a new URL. The reply_status value specified in this action is used as the status code of HTTP response message which is sent back to client (Normally a browser). The HTTP status code for redirection is 3xx, for example, 301, 302, 303, 307, etc. The redirect_url is the new URL that the HTTP request message is redirected to. Normally browser will send another HTTP request to the new URL after receiving a redirection response message. Captured variables and built-in variables can be used in redirect_url field. For example, to redirect all HTTP requests to HTTPS requests for a virtual server. We create an LbRule without any conditions, add an LbHttpRedirectAction to the rule. Set the redirect_url field of the LbHttpRedirectAction to: https://$_host$_request_uri And set redirect_status to "302", which means found. This rule will redirect all HTTP requests to HTTPS server port on the same host.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - redirect_status (
str) – HTTP response status code - redirect_url (
str) – The URL that the HTTP request is redirected to - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- redirect_status (
-
class
com.vmware.nsx_policy.model_client.LbHttpRejectAction(reply_message=None, reply_status=None, type='LbHttpRejectAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to reject HTTP request messages. The specified reply_status value is used as the status code for the corresponding HTTP response message which is sent back to client (Normally a browser) indicating the reason it was rejected. Reference official HTTP status code list for your specific HTTP version to set the reply_status properly. LbHttpRejectAction does not support variables.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - reply_message (
strorNone) – Response message - reply_status (
str) – HTTP response status code - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- reply_message (
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestBodyCondition(body_value=None, case_sensitive=None, match_type=None, inverse=None, type='LbHttpRequestBodyCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match the message body of an HTTP request. Typically, only HTTP POST, PATCH, or PUT requests have request body. The match_type field defines how body_value field is used to match the body of HTTP requests.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestCookieCondition(case_sensitive=None, cookie_name=None, cookie_value=None, match_type=None, inverse=None, type='LbHttpRequestCookieCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match HTTP request messages by cookie which is a specific type of HTTP header. The match_type and case_sensitive define how to compare cookie value.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestHeader(header_name=None, header_value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_name (
str) – Name of HTTP request header - header_value (
str) – Value of HTTP request header
- header_name (
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LbHttpRequestHeaderCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match HTTP request messages by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP requests. The header_name field does not support match types.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestHeaderDeleteAction(header_name=None, type='LbHttpRequestHeaderDeleteAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to delete header fields of HTTP request messages at HTTP_REQUEST_REWRITE phase. One action can be used to delete all headers with same header name. To delete headers with different header names, multiple actions must be defined.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_name (
str) – Name of a header field of HTTP request message - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- header_name (
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpRequestHeaderRewriteAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to rewrite header fields of matched HTTP request messages to specified new values. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_name (
str) – Name of HTTP request header - header_value (
str) – Value of HTTP request header - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- header_name (
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestMethodCondition(method=None, inverse=None, type='LbHttpRequestMethodCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match method of HTTP requests. If the method of an HTTP request is same as the method specified in this condition, the HTTP request match this condition. For example, if the method field is set to GET in this condition, any HTTP request with GET method matches the condition.
Tip
The arguments are used to initialize data attributes with the same names.
-
METHOD_GET= 'GET'¶
-
METHOD_HEAD= 'HEAD'¶
-
METHOD_OPTIONS= 'OPTIONS'¶
-
METHOD_POST= 'POST'¶
-
METHOD_PUT= 'PUT'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestUriArgumentsCondition(case_sensitive=None, match_type=None, uri_arguments=None, inverse=None, type='LbHttpRequestUriArgumentsCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match URI arguments aka query string of Http request messages, for example, in URI http://exaple.com?foo=1&bar=2, the "foo=1&bar=2" is the query string containing URI arguments. In an URI scheme, query string is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. The uri_arguments field can be specified as a regular expression(Set match_type to REGEX). For example, "foo=(?<x>\d+)". It matches HTTP requests whose URI arguments containing "foo", the value of foo contains only digits. And the value of foo is captured as $x which can be used in LbRuleAction fields which support variables.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestUriCondition(case_sensitive=None, match_type=None, uri=None, inverse=None, type='LbHttpRequestUriCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match URIs(Uniform Resource Identifier) of HTTP request messages. The URI field can be specified as a regular expression. If an HTTP request message is requesting an URI which matches specified regular expression, it matches the condition. The syntax of whole URI looks like this: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] This condition matches only the path part of entire URI. When match_type field is specified as REGEX, the uri field is used as a regular expression to match URI path of HTTP requests. For example, to match any URI that has "/image/" or "/images/", uri field can be specified as: "/image[s]?/". Named capturing groups can be used in the uri field to capture substrings of matched URIs and store them in variables for use in LbRuleAction. For example, specify uri field as: "/news/(?<year>\d+)/(?<month>\d+)/(?<article>.\*)" If the URI path is /articles/news/2017/06/xyz.html, then substring "2017" is captured in variable year, "06" is captured in variable month, and "xyz.html" is captured in variable article. These variables can then be used in an LbRuleAction field which supports variables, such as uri field of LbHttpRequestUriRewriteAction. For example, set the uri field of LbHttpRequestUriRewriteAction as: "/articles/news/$year-$month-$article" Then the URI path /articles/news/2017/06/xyz.html is rewritten to: "/articles/news/2017-06-xyz.html"
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestUriRewriteAction(uri=None, uri_arguments=None, type='LbHttpRequestUriRewriteAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to rewrite URIs in matched HTTP request messages. Specify the uri and uri_arguments fields in this condition to rewrite the matched HTTP request message’s URI and URI arguments to the new values. Full URI scheme of HTTP messages have following syntax: scheme:[//[user[:password]\@]host[:port]][/path][?query][#fragment] The uri field of this action is used to rewrite the /path part in above scheme. And the uri_arguments field is used to rewrite the query part. Captured variables and built-in variables can be used in the uri and uri_arguments fields. Check the example in LbRuleAction to see how to use variables in this action.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - uri (
str) – URI of HTTP request - uri_arguments (
strorNone) – Query string of URI, typically contains key value pairs, for example: foo1=bar1&foo2=bar2 - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- uri (
-
class
com.vmware.nsx_policy.model_client.LbHttpRequestVersionCondition(version=None, inverse=None, type='LbHttpRequestVersionCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match the HTTP protocol version of the HTTP request messages.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - version (
str) –Possible values are:
LbHttpRequestVersionCondition.VERSION__1_0LbHttpRequestVersionCondition.VERSION__1_1LbHttpRequestVersionCondition.VERSION__2_0
HTTP version - inverse (
boolorNone) – A flag to indicate whether reverse the match result of this condition - type (
str) –Possible values are:
LbRuleCondition.TYPE_LBHTTPREQUESTMETHODCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURICONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURIARGUMENTSCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTVERSIONCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTHEADERCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTCOOKIECONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTBODYCONDITIONLbRuleCondition.TYPE_LBHTTPRESPONSEHEADERCONDITIONLbRuleCondition.TYPE_LBTCPHEADERCONDITIONLbRuleCondition.TYPE_LBIPHEADERCONDITIONLbRuleCondition.TYPE_LBVARIABLECONDITIONLbRuleCondition.TYPE_LBHTTPSSLCONDITION
Type of load balancer rule condition
-
VERSION_1_0= 'HTTP_VERSION_1_0'¶
-
VERSION_1_1= 'HTTP_VERSION_1_1'¶
-
VERSION_2_0= 'HTTP_VERSION_2_0'¶
- version (
-
class
com.vmware.nsx_policy.model_client.LbHttpResponseHeaderCondition(case_sensitive=None, header_name=None, header_value=None, match_type=None, inverse=None, type='LbHttpResponseHeaderCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match HTTP response messages from backend servers by HTTP header fields. HTTP header fields are components of the header section of HTTP request and response messages. They define the operating parameters of an HTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One condition can be used to match one header field, to match multiple header fields, multiple conditions must be specified. The match_type field defines how header_value field is used to match HTTP responses. The header_name field does not support match types.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpResponseHeaderDeleteAction(header_name=None, type='LbHttpResponseHeaderDeleteAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to delete header fields of HTTP response messages at HTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers with same header name. To delete headers with different header names, multiple actions must be defined
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_name (
str) – Name of a header field of HTTP response message - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- header_name (
-
class
com.vmware.nsx_policy.model_client.LbHttpResponseHeaderRewriteAction(header_name=None, header_value=None, type='LbHttpResponseHeaderRewriteAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to rewrite header fields of HTTP response messages to specified new values at HTTP_RESPONSE_REWRITE phase. One action can be used to rewrite one header field. To rewrite multiple header fields, multiple actions must be defined. Captured variables and built-in variables can be used in the header_value field, header_name field does not support variables.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - header_name (
str) – Name of a header field of HTTP request message - header_value (
str) – Value of header field - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- header_name (
-
class
com.vmware.nsx_policy.model_client.LbHttpSslCondition(client_certificate_issuer_dn=None, client_certificate_subject_dn=None, client_supported_ssl_ciphers=None, session_reused=None, used_protocol=None, used_ssl_cipher=None, inverse=None, type='LbHttpSslCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match SSL handshake and SSL connection at all phases.If multiple properties are configured, the rule is considered a match when all the configured properties are matched.
Tip
The arguments are used to initialize data attributes with the same names.
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
CLIENT_SUPPORTED_SSL_CIPHERS_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
SESSION_REUSED_IGNORE= 'IGNORE'¶
-
SESSION_REUSED_NEW= 'NEW'¶
-
SESSION_REUSED_REUSED= 'REUSED'¶
-
USED_PROTOCOL_SSL_V2= 'SSL_V2'¶
-
USED_PROTOCOL_SSL_V3= 'SSL_V3'¶
-
USED_PROTOCOL_TLS_V1= 'TLS_V1'¶
-
USED_PROTOCOL_TLS_V1_1= 'TLS_V1_1'¶
-
USED_PROTOCOL_TLS_V1_2= 'TLS_V1_2'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
USED_SSL_CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
USED_SSL_CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
USED_SSL_CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
USED_SSL_CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
USED_SSL_CIPHER_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
USED_SSL_CIPHER_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
-
class
com.vmware.nsx_policy.model_client.LbHttpsMonitor(certificate_chain_depth=None, cipher_group_label=None, ciphers=None, client_certificate_id=None, is_fips=None, is_secure=None, protocols=None, request_body=None, request_headers=None, request_method=None, request_url=None, request_version=None, response_body=None, response_status_codes=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - certificate_chain_depth (
longorNone) – authentication depth is used to set the verification depth in the server certificates chain. format: int64 - cipher_group_label (
strorNone) –Possible values are:
LbHttpsMonitor.CIPHER_GROUP_LABEL_BALANCEDLbHttpsMonitor.CIPHER_GROUP_LABEL_HIGH_SECURITYLbHttpsMonitor.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITYLbHttpsMonitor.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI. - ciphers (
listofstrorNone) –Possible values are:
LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHALbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHALbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHALbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHALbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_CBC_SHALbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_CBC_SHALbHttpsMonitor.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHALbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHALbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256LbHttpsMonitor.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384LbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_CBC_SHA256LbHttpsMonitor.CIPHERS_RSA_WITH_AES_128_GCM_SHA256LbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_CBC_SHA256LbHttpsMonitor.CIPHERS_RSA_WITH_AES_256_GCM_SHA384LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHALbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384LbHttpsMonitor.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHALbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384LbHttpsMonitor.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHALbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384LbHttpsMonitor.CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384
supported SSL cipher list to servers - client_certificate_id (
strorNone) – client certificate can be specified to support client authentication. - is_fips (
boolorNone) – This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_secure (
boolorNone) – This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protocols (
listofstrorNone) –Possible values are:
LbHttpsMonitor.PROTOCOLS_SSL_V2LbHttpsMonitor.PROTOCOLS_SSL_V3LbHttpsMonitor.PROTOCOLS_TLS_V1LbHttpsMonitor.PROTOCOLS_TLS_V1_1LbHttpsMonitor.PROTOCOLS_TLS_V1_2
SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
- request_body (
strorNone) – String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST. - request_headers (
listofLbHttpRequestHeaderorNone) – Array of HTTP request headers - request_method (
strorNone) –Possible values are:
LbHttpsMonitor.REQUEST_METHOD_GETLbHttpsMonitor.REQUEST_METHOD_OPTIONSLbHttpsMonitor.REQUEST_METHOD_POSTLbHttpsMonitor.REQUEST_METHOD_HEADLbHttpsMonitor.REQUEST_METHOD_PUT
the health check method for HTTP monitor type - request_url (
strorNone) – URL used for HTTP monitor - request_version (
strorNone) –Possible values are:
LbHttpsMonitor.REQUEST_VERSION__1_0LbHttpsMonitor.REQUEST_VERSION__1_1LbHttpsMonitor.REQUEST_VERSION__2_0
HTTP request version - response_body (
strorNone) – If HTTP response body match string (regular expressions not supported) is specified (using LbHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful. - response_status_codes (
listoflongorNone) – The HTTP response status code should be a valid HTTP status code. format: int32 - server_auth (
strorNone) –Possible values are:
server authentication mode - server_auth_ca_ids (
listofstrorNone) – If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. - server_auth_crl_ids (
listofstrorNone) – A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates. - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_GROUP_LABEL_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABEL_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABEL_HIGH_SECURITY= 'HIGH_SECURITY'¶
-
PROTOCOLS_SSL_V2= 'SSL_V2'¶
-
PROTOCOLS_SSL_V3= 'SSL_V3'¶
-
PROTOCOLS_TLS_V1= 'TLS_V1'¶
-
PROTOCOLS_TLS_V1_1= 'TLS_V1_1'¶
-
PROTOCOLS_TLS_V1_2= 'TLS_V1_2'¶
-
REQUEST_METHOD_GET= 'GET'¶
-
REQUEST_METHOD_HEAD= 'HEAD'¶
-
REQUEST_METHOD_OPTIONS= 'OPTIONS'¶
-
REQUEST_METHOD_POST= 'POST'¶
-
REQUEST_METHOD_PUT= 'PUT'¶
-
REQUEST_VERSION_1_0= 'HTTP_VERSION_1_0'¶
-
REQUEST_VERSION_1_1= 'HTTP_VERSION_1_1'¶
-
REQUEST_VERSION_2_0= 'HTTP_VERSION_2_0'¶
-
SERVER_AUTH_IGNORE= 'IGNORE'¶
-
SERVER_AUTH_REQUIRED= 'REQUIRED'¶
- certificate_chain_depth (
-
class
com.vmware.nsx_policy.model_client.LbIcmpMonitor(data_length=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - data_length (
longorNone) – The data size(in byte) of the ICMP healthcheck packet format: int64 - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- data_length (
-
class
com.vmware.nsx_policy.model_client.LbIpHeaderCondition(source_address=None, inverse=None, type='LbIpHeaderCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match IP header fields of HTTP messages. Currently, only the source IP address is supported. IP addresses can be expressed as a single IP address like 10.1.1.1, or a range of IP addresses like 10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - source_address (
str) – Source IP address of HTTP message format: address-or-block-or-range - inverse (
boolorNone) – A flag to indicate whether reverse the match result of this condition - type (
str) –Possible values are:
LbRuleCondition.TYPE_LBHTTPREQUESTMETHODCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURICONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURIARGUMENTSCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTVERSIONCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTHEADERCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTCOOKIECONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTBODYCONDITIONLbRuleCondition.TYPE_LBHTTPRESPONSEHEADERCONDITIONLbRuleCondition.TYPE_LBTCPHEADERCONDITIONLbRuleCondition.TYPE_LBIPHEADERCONDITIONLbRuleCondition.TYPE_LBVARIABLECONDITIONLbRuleCondition.TYPE_LBHTTPSSLCONDITION
Type of load balancer rule condition
- source_address (
-
class
com.vmware.nsx_policy.model_client.LbMonitor(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbMonitor', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_LBHTTPMONITOR= 'LbHttpMonitor'¶
-
RESOURCE_TYPE_LBHTTPSMONITOR= 'LbHttpsMonitor'¶
-
RESOURCE_TYPE_LBICMPMONITOR= 'LbIcmpMonitor'¶
-
RESOURCE_TYPE_LBPASSIVEMONITOR= 'LbPassiveMonitor'¶
-
RESOURCE_TYPE_LBTCPMONITOR= 'LbTcpMonitor'¶
-
RESOURCE_TYPE_LBUDPMONITOR= 'LbUdpMonitor'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbMonitorListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – paginated list of load balancer monitors When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbMonitor. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbMonitor.
- links (
-
class
com.vmware.nsx_policy.model_client.LbPassiveMonitor(max_fails=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbPassiveMonitor', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - max_fails (
longorNone) – When the consecutive failures reach this value, then the member is considered temporarily unavailable for a configurable period format: int64 - timeout (
longorNone) – After this timeout period, the member is tried again for a new connection to see if it is available. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- max_fails (
-
class
com.vmware.nsx_policy.model_client.LbPersistenceCookieTime(cookie_max_idle=None, type='LbPersistenceCookieTime')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cookie_max_idle (
long) – HTTP cookie max-age to expire cookie, only available for insert mode. format: int64 - type (
str) –Possible values are:
Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting
- cookie_max_idle (
-
class
com.vmware.nsx_policy.model_client.LbPersistenceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbPersistenceProfile', tags=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILELbPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
Source-ip persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. Cookie persistence allows related client connections, identified by the same cookie in HTTP requests, to be redirected to the same server.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - persistence_shared (
boolorNone) – If persistence shared flag is not set in the cookie persistence profile bound to a virtual server, it defaults to cookie persistence that is private to each virtual server and is qualified by the pool. This is accomplished by load balancer inserting a cookie with name in the format <name>.<virtual_server_id>.<pool_id>. If persistence shared flag is set in the cookie persistence profile, in cookie insert mode, cookie persistence could be shared across multiple virtual servers that are bound to the same pools. The cookie name would be changed to <name>.<profile-id>.<pool-id>. If persistence shared flag is not set in the sourceIp persistence profile bound to a virtual server, each virtual server that the profile is bound to maintains its own private persistence table. If persistence shared flag is set in the sourceIp persistence profile, all virtual servers the profile is bound to share the same persistence table.
-
RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILE= 'LbCookiePersistenceProfile'¶
-
RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE= 'LbSourceIpPersistenceProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbPersistenceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – paginated list of load balancer persistence profiles When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbPersistenceProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbPersistenceProfile.
- links (
-
class
com.vmware.nsx_policy.model_client.LbPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, active_monitor_ids=None, algorithm=None, member_group=None, members=None, min_active_members=None, passive_monitor_id=None, snat_translation=None, tcp_multiplexing_enabled=None, tcp_multiplexing_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - active_monitor_ids (
listofstrorNone) – In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Active healthchecks are disabled by default and can be enabled for a server pool by binding a health monitor to the pool. Currently, only one active health monitor can be configured per server pool. - algorithm (
strorNone) –Possible values are:
LbPool.ALGORITHM_ROUND_ROBINLbPool.ALGORITHM_WEIGHTED_ROUND_ROBINLbPool.ALGORITHM_LEAST_CONNECTIONLbPool.ALGORITHM_WEIGHTED_LEAST_CONNECTIONLbPool.ALGORITHM_IP_HASH
Load balancing algorithm, configurable per pool controls how the incoming connections are distributed among the members.
- member_group (
PoolMemberGrouporNone) – Load balancer pool support grouping object as dynamic pool members. When member group is defined, members setting should not be specified. - members (
listofPoolMemberorNone) – Server pool consists of one or more pool members. Each pool member is identified, typically, by an IP address and a port. - min_active_members (
longorNone) – A pool is considered active if there are at least certain minimum number of members. format: int64 - passive_monitor_id (
strorNone) – Passive healthchecks are disabled by default and can be enabled by attaching a passive health monitor to a server pool. Each time a client connection to a pool member fails, its failed count is incremented. For pools bound to L7 virtual servers, a connection is considered to be failed and failed count is incremented if any TCP connection errors (e.g. TCP RST or failure to send data) or SSL handshake failures occur. For pools bound to L4 virtual servers, if no response is received to a TCP SYN sent to the pool member or if a TCP RST is received in response to a TCP SYN, then the pool member is considered to have failed and the failed count is incremented. - snat_translation (
vmware.vapi.struct.VapiStructorNone) – Depending on the topology, Source NAT (SNAT) may be required to ensure traffic from the server destined to the client is received by the load balancer. SNAT can be enabled per pool. If SNAT is not enabled for a pool, then load balancer uses the client IP and port (spoofing) while establishing connections to the servers. This is referred to as no-SNAT or TRANSPARENT mode. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbSnatTranslation. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbSnatTranslation. - tcp_multiplexing_enabled (
boolorNone) – TCP multiplexing allows the same TCP connection between load balancer and the backend server to be used for sending multiple client requests from different client TCP connections. - tcp_multiplexing_number (
longorNone) – The maximum number of TCP connections per pool that are idly kept alive for sending future client requests. format: int64
-
ALGORITHM_IP_HASH= 'IP_HASH'¶
-
ALGORITHM_LEAST_CONNECTION= 'LEAST_CONNECTION'¶
-
ALGORITHM_ROUND_ROBIN= 'ROUND_ROBIN'¶
-
ALGORITHM_WEIGHTED_LEAST_CONNECTION= 'WEIGHTED_LEAST_CONNECTION'¶
-
ALGORITHM_WEIGHTED_ROUND_ROBIN= 'WEIGHTED_ROUND_ROBIN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbPool) – paginated list of pools
- links (
-
class
com.vmware.nsx_policy.model_client.LbPoolMemberStatistics(ip_address=None, port=None, statistics=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_address (
str) – Pool member IP address format: ip - port (
strorNone) – The port is configured in pool member. For virtual server port range case, pool member port must be null. format: port-or-range - statistics (
LbStatisticsCounter) – Pool member statistics counter
- ip_address (
-
class
com.vmware.nsx_policy.model_client.LbPoolMemberStatus(failure_cause=None, ip_address=None, last_check_time=None, last_state_change_time=None, port=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - failure_cause (
strorNone) – The healthcheck failure cause when status is DOWN - ip_address (
str) – Pool member IP address format: ip - last_check_time (
longorNone) – Timestamp in milliseconds since epoch format: int64 - last_state_change_time (
longorNone) – Timestamp in milliseconds since epoch format: int64 - port (
strorNone) – The port is configured in pool member. For virtual server port range case, pool member port must be null. format: port-or-range - status (
str) –Possible values are:
LbPoolMemberStatus.STATUS_UPLbPoolMemberStatus.STATUS_DOWNLbPoolMemberStatus.STATUS_DISABLEDLbPoolMemberStatus.STATUS_GRACEFUL_DISABLEDLbPoolMemberStatus.STATUS_UNUSED
UP means that pool member is enabled and monitors have marked the pool member as UP. If the pool member has no monitor configured, it would be treated as UP. DOWN means that pool member is enabled and monitors have marked the pool member as DOWN. DISABLED means that admin state of pool member is set to DISABLED. GRACEFUL_DISABLED means that admin state of pool member is set to GRACEFUL_DISABLED. UNUSED means that the pool member is not used when the IP list size of member group exceeds the maximum setting. The remaining IP addresses would not be used as available backend servers, hence mark the status as UNUSED.
-
STATUS_DISABLED= 'DISABLED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_GRACEFUL_DISABLED= 'GRACEFUL_DISABLED'¶
-
STATUS_UNUSED= 'UNUSED'¶
-
STATUS_UP= 'UP'¶
- failure_cause (
-
class
com.vmware.nsx_policy.model_client.LbPoolStatistics(last_update_timestamp=None, members=None, pool_id=None, statistics=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - last_update_timestamp (
longorNone) – Timestamp when the data was last updated format: int64 - members (
listofLbPoolMemberStatisticsorNone) – Statistics of load balancer pool members - pool_id (
str) – Load balancer pool identifier - statistics (
LbStatisticsCounter) – Virtual server statistics counter
- last_update_timestamp (
-
class
com.vmware.nsx_policy.model_client.LbPoolStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbPoolStatistics) – paginated statistics list of pools
- links (
-
class
com.vmware.nsx_policy.model_client.LbPoolStatus(last_update_timestamp=None, members=None, pool_id=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - last_update_timestamp (
longorNone) – Timestamp when the data was last updated format: int64 - members (
listofLbPoolMemberStatusorNone) – Status of load balancer pool members - pool_id (
str) – Load balancer pool identifier - status (
strorNone) –Possible values are:
LbPoolStatus.STATUS_UPLbPoolStatus.STATUS_PARTIALLY_UPLbPoolStatus.STATUS_PRIMARY_DOWNLbPoolStatus.STATUS_DOWNLbPoolStatus.STATUS_DETACHEDLbPoolStatus.STATUS_UNKNOWN
UP means that all primary members are in UP status. PARTIALLY_UP means that some(not all) primary members are in UP status, the number of these active members is larger or equal to certain number(min_active_members) which is defined in LbPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members are in UP status but backup members are in UP status, connections to this pool would be dispatched to backup members. DOWN means that all primary and backup members are DOWN. DETACHED means that the pool is not bound to any virtual server. UNKOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working).
-
STATUS_DETACHED= 'DETACHED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_PARTIALLY_UP= 'PARTIALLY_UP'¶
-
STATUS_PRIMARY_DOWN= 'PRIMARY_DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- last_update_timestamp (
-
class
com.vmware.nsx_policy.model_client.LbPoolStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbPoolStatus) – paginated status list of pools
- links (
-
class
com.vmware.nsx_policy.model_client.LbRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, actions=None, match_conditions=None, match_strategy=None, phase=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with application profile LbHttpProfile. Each application rule consists of one or more match conditions and one or more actions. Load balancer rules could be used by different load balancer services.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - actions (
listofvmware.vapi.struct.VapiStruct) – A list of actions to be executed at specified phase when load balancer rule matches. The actions are used to manipulate application traffic, such as rewrite URI of HTTP messages, redirect HTTP messages, etc. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbRuleAction. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbRuleAction. - match_conditions (
listofvmware.vapi.struct.VapiStructorNone) – A list of match conditions used to match application traffic. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion to match application traffic. If no match conditions are specified, then the load balancer rule will always match and it is used typically to define default rules. If more than one match condition is specified, then match strategy determines if all conditions should match or any one condition should match for the load balancer rule to considered a match. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLbRuleCondition. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLbRuleCondition. - match_strategy (
str) –Possible values are:
Strategy to define how load balancer rule is considered a match when multiple match conditions are specified in one rule. If match_stragety is set to ALL, then load balancer rule is considered a match only if all the conditions match. If match_strategy is set to ANY, then load balancer rule is considered a match if any one of the conditions match.
- phase (
str) –Possible values are:
Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. When an HTTP request message is received by load balancer, all HTTP_REQUEST_REWRITE rules, if present are executed in the order they are applied to virtual server. And then if HTTP_FORWARDING rules present, only first matching rule’s action is executed, remaining rules are not checked. HTTP_FORWARDING rules can have only one action. If the request is forwarded to a backend server and the response goes back to load balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed in the order they are applied to the virtual server.
-
MATCH_STRATEGY_ALL= 'ALL'¶
-
MATCH_STRATEGY_ANY= 'ANY'¶
-
PHASE_FORWARDING= 'HTTP_FORWARDING'¶
-
PHASE_REQUEST_REWRITE= 'HTTP_REQUEST_REWRITE'¶
-
PHASE_RESPONSE_REWRITE= 'HTTP_RESPONSE_REWRITE'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbRuleAction(type='LbRuleAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer rule actions are used to manipulate application traffic. Currently load balancer rules can be used at three load balancer processing phases. Each phase has its own supported type of actions. Supported actions in HTTP_REQUST_REWRITE phase are: LbHttpRequestUriRewriteAction LbHttpRequestHeaderRewriteAction LbHttpRequestHeaderDeleteAction LbVariableAssignmentAction Supported actions in HTTP_FORWARDING phase are: LbHttpRejectAction LbHttpRedirectAction LbSelectPoolAction Supported action in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderRewriteAction LbHttpResponseHeaderDeleteAction If the match type of an LbRuleCondition field is specified as REGEX and named capturing groups are used in the specified regular expression. The groups can be used as variables in LbRuleAction fields. For example, define a rule with LbHttpRequestUriCondition as match condition and LbHttpRequestUriRewriteAction as action. Set match_type field of LbHttpRequestUriCondition to REGEX, and set uri field to "/news/(?<year>\d+)/(?<month>\d+)/(?<article>.\*)". Set uri field of LbHttpRequestUriRewriteAction to: "/news/$year-$month/$article" In uri field of LbHttpRequestUriCondition, the (?<year>\d+), (?<month>\d+) and (?<article>.\*) are named capturing groups, they define variables named $year, $month and $article respectively. The defined variables are used in LbHttpRequestUriRewriteAction. For a matched HTTP request with URI "/news/2017/06/xyz.html", the substring "2017" is captured in variable $year, "06" is captured in variable $month, and "xyz.html" is captured in variable $article. The LbHttpRequestUriRewriteAction will rewrite the URI to: "/news/2017-06/xyz.html" A set of built-in variables can be used in LbRuleAction as well. The name of built-in variables start with underscore, the name of user defined variables is not allowed to start with underscore. Following are some of the built-in variables: $_scheme: Reference the scheme part of matched HTTP messages, could be "http" or "https". $_host: Host of matched HTTP messages, for example "www.example.com". $_server_port: Port part of URI, it is also the port of the server which accepted a request. Default port is 80 for http and 443 for https. $_uri: The URI path, for example "/products/sample.html". $_request_uri: Full original request URI with arguments, for example, "/products/sample.html?a=b&c=d". $_args: URI arguments, for instance "a=b&c=d" $_is_args: "?" if a request has URI arguments, or an empty string otherwise. For the full list of built-in variables, please reference the NSX-T Administrator’s Guide.
Tip
The arguments are used to initialize data attributes with the same names.
-
TYPE_LBHTTPREDIRECTACTION= 'LbHttpRedirectAction'¶
-
TYPE_LBHTTPREJECTACTION= 'LbHttpRejectAction'¶
-
TYPE_LBHTTPREQUESTHEADERDELETEACTION= 'LbHttpRequestHeaderDeleteAction'¶
-
TYPE_LBHTTPREQUESTHEADERREWRITEACTION= 'LbHttpRequestHeaderRewriteAction'¶
-
TYPE_LBHTTPREQUESTURIREWRITEACTION= 'LbHttpRequestUriRewriteAction'¶
-
TYPE_LBHTTPRESPONSEHEADERDELETEACTION= 'LbHttpResponseHeaderDeleteAction'¶
-
TYPE_LBHTTPRESPONSEHEADERREWRITEACTION= 'LbHttpResponseHeaderRewriteAction'¶
-
TYPE_LBSELECTPOOLACTION= 'LbSelectPoolAction'¶
-
TYPE_LBSELECTSERVERACTION= 'LbSelectServerAction'¶
-
TYPE_LBVARIABLEASSIGNMENTACTION= 'LbVariableAssignmentAction'¶
-
-
class
com.vmware.nsx_policy.model_client.LbRuleCondition(inverse=None, type='LbRuleCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructMatch conditions are used to match application traffic passing through load balancers. Multiple match conditions can be specified in one load balancer rule, each match condition defines a criterion for application traffic. If inverse field is set to true, the match result of the condition is inverted. If more than one match condition is specified, match strategy determines if all conditions should match or any one condition should match for the load balancer rule to be considered a match. Currently only HTTP messages are supported by load balancer rules. Each load balancer rule is used at a specific phase of load balancer processing. Currently three phases are supported, HTTP_REQUEST_REWRITE, HTTP_FORWARDING and HTTP_RESPONSE_REWRITE. Each phase supports certain types of match conditions, supported match conditions in HTTP_REQUEST_REWRITE phase are: LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition Supported match conditions in HTTP_FORWARDING phase are: LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbHttpRequestBodyCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition Supported match condition in HTTP_RESPONSE_REWRITE phase is: LbHttpResponseHeaderCondition LbHttpRequestMethodCondition LbHttpRequestUriCondition LbHttpRequestUriArgumentsCondition LbHttpRequestVersionCondition LbHttpRequestHeaderCondition LbHttpRequestCookieCondition LbTcpHeaderCondition LbIpHeaderCondition LbVariableCondition LbHttpSslCondition
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - inverse (
boolorNone) – A flag to indicate whether reverse the match result of this condition - type (
str) –Possible values are:
LbRuleCondition.TYPE_LBHTTPREQUESTMETHODCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURICONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURIARGUMENTSCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTVERSIONCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTHEADERCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTCOOKIECONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTBODYCONDITIONLbRuleCondition.TYPE_LBHTTPRESPONSEHEADERCONDITIONLbRuleCondition.TYPE_LBTCPHEADERCONDITIONLbRuleCondition.TYPE_LBIPHEADERCONDITIONLbRuleCondition.TYPE_LBVARIABLECONDITIONLbRuleCondition.TYPE_LBHTTPSSLCONDITION
Type of load balancer rule condition
-
TYPE_LBHTTPREQUESTBODYCONDITION= 'LbHttpRequestBodyCondition'¶
-
TYPE_LBHTTPREQUESTCOOKIECONDITION= 'LbHttpRequestCookieCondition'¶
-
TYPE_LBHTTPREQUESTHEADERCONDITION= 'LbHttpRequestHeaderCondition'¶
-
TYPE_LBHTTPREQUESTMETHODCONDITION= 'LbHttpRequestMethodCondition'¶
-
TYPE_LBHTTPREQUESTURIARGUMENTSCONDITION= 'LbHttpRequestUriArgumentsCondition'¶
-
TYPE_LBHTTPREQUESTURICONDITION= 'LbHttpRequestUriCondition'¶
-
TYPE_LBHTTPREQUESTVERSIONCONDITION= 'LbHttpRequestVersionCondition'¶
-
TYPE_LBHTTPRESPONSEHEADERCONDITION= 'LbHttpResponseHeaderCondition'¶
-
TYPE_LBHTTPSSLCONDITION= 'LbHttpSslCondition'¶
-
TYPE_LBIPHEADERCONDITION= 'LbIpHeaderCondition'¶
-
TYPE_LBTCPHEADERCONDITION= 'LbTcpHeaderCondition'¶
-
TYPE_LBVARIABLECONDITION= 'LbVariableCondition'¶
- inverse (
-
class
com.vmware.nsx_policy.model_client.LbRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbRule) – paginated list of LB rules
- links (
-
class
com.vmware.nsx_policy.model_client.LbSelectPoolAction(pool_id=None, type='LbSelectPoolAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to select a pool for matched HTTP request messages. The pool is specified by UUID. The matched HTTP request messages are forwarded to the specified pool.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - pool_id (
str) – UUID of load balancer pool - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- pool_id (
-
class
com.vmware.nsx_policy.model_client.LbServerSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, cipher_group_label=None, ciphers=None, is_fips=None, is_secure=None, protocols=None, session_cache_enabled=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - cipher_group_label (
strorNone) –Possible values are:
LbServerSslProfile.CIPHER_GROUP_LABEL_BALANCEDLbServerSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITYLbServerSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITYLbServerSslProfile.CIPHER_GROUP_LABEL_CUSTOM
It is a label of cipher group which is mostly consumed by GUI. - ciphers (
listofstrorNone) –Possible values are:
LbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256LbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384LbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHALbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHALbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHALbServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHALbServerSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHALbServerSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHALbServerSslProfile.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHALbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHALbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256LbServerSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384LbServerSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA256LbServerSslProfile.CIPHERS_RSA_WITH_AES_128_GCM_SHA256LbServerSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA256LbServerSslProfile.CIPHERS_RSA_WITH_AES_256_GCM_SHA384LbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHALbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256LbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256LbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384LbServerSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384LbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHALbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256LbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256LbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384LbServerSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384LbServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHALbServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256LbServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256LbServerSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384supported SSL cipher list to client side
- is_fips (
boolorNone) – This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_secure (
boolorNone) – This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protocols (
listofstrorNone) –Possible values are:
LbServerSslProfile.PROTOCOLS_SSL_V2LbServerSslProfile.PROTOCOLS_SSL_V3LbServerSslProfile.PROTOCOLS_TLS_V1LbServerSslProfile.PROTOCOLS_TLS_V1_1LbServerSslProfile.PROTOCOLS_TLS_V1_2
SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
- session_cache_enabled (
boolorNone) – SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHERS_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
CIPHERS_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_GROUP_LABEL_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABEL_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABEL_HIGH_SECURITY= 'HIGH_SECURITY'¶
-
PROTOCOLS_SSL_V2= 'SSL_V2'¶
-
PROTOCOLS_SSL_V3= 'SSL_V3'¶
-
PROTOCOLS_TLS_V1= 'TLS_V1'¶
-
PROTOCOLS_TLS_V1_1= 'TLS_V1_1'¶
-
PROTOCOLS_TLS_V1_2= 'TLS_V1_2'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbServerSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbServerSslProfile) – paginated list of load balancer server SSL profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LbService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, access_log_enabled=None, attachment=None, enabled=None, error_log_level=None, size=None, virtual_server_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - access_log_enabled (
boolorNone) – whether access log is enabled - attachment (
ResourceReferenceorNone) – LBS could be instantiated (or created) on the Logical router, etc. Typically, it could be applied to Tier1 LogicalRouter. It can be attached to Tier0 LogicalRouter either in non-multi-tenant environments or to provide load balancing for infrastructure services offered by the provider. - enabled (
boolorNone) – whether the load balancer service is enabled - error_log_level (
strorNone) –Possible values are:
LbService.ERROR_LOG_LEVEL_DEBUGLbService.ERROR_LOG_LEVEL_INFOLbService.ERROR_LOG_LEVEL_WARNINGLbService.ERROR_LOG_LEVEL_ERRORLbService.ERROR_LOG_LEVEL_CRITICALLbService.ERROR_LOG_LEVEL_ALERTLbService.ERROR_LOG_LEVEL_EMERGENCY
Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
- size (
strorNone) –Possible values are:
the size of load balancer service - virtual_server_ids (
listofstrorNone) – virtual servers can be associated to LbService(which is similar to physical/virtual load balancer), Lb virtual servers, pools and other entities could be defined independently, the virtual server identifier list here would be used to maintain the relationship of LbService and other Lb entities.
-
ERROR_LOG_LEVEL_ALERT= 'ALERT'¶
-
ERROR_LOG_LEVEL_CRITICAL= 'CRITICAL'¶
-
ERROR_LOG_LEVEL_DEBUG= 'DEBUG'¶
-
ERROR_LOG_LEVEL_EMERGENCY= 'EMERGENCY'¶
-
ERROR_LOG_LEVEL_ERROR= 'ERROR'¶
-
ERROR_LOG_LEVEL_INFO= 'INFO'¶
-
ERROR_LOG_LEVEL_WARNING= 'WARNING'¶
-
SIZE_LARGE= 'LARGE'¶
-
SIZE_MEDIUM= 'MEDIUM'¶
-
SIZE_SMALL= 'SMALL'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbService) – paginated list of load balancer services
- links (
-
class
com.vmware.nsx_policy.model_client.LbSessionCookieTime(cookie_max_idle=None, cookie_max_life=None, type='LbSessionCookieTime')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - cookie_max_idle (
longorNone) – Instead of using HTTP Cookie max-age and relying on client to expire the cookie, max idle time and/or max lifetime of the cookie can be used. Max idle time, if configured, specifies the maximum interval the cookie is valid for from the last time it was seen in a request. It is available for insert mode. format: int64 - cookie_max_life (
longorNone) – Max life time, if configured, specifies the maximum interval the cookie is valid for from the first time the cookie was seen in a request. It is available for insert mode. format: int64 - type (
str) –Possible values are:
Both session cookie and persistence cookie are supported, Use LbSessionCookieTime for session cookie time setting, Use LbPersistenceCookieTime for persistence cookie time setting
- cookie_max_idle (
-
class
com.vmware.nsx_policy.model_client.LbSnatAutoMap(port_overload=None, type='LbSnatAutoMap')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - port_overload (
longorNone) – Both SNAT automap and SNAT IP list modes support port overloading which allows the same SNAT IP and port to be used for multiple backend connections as long as the tuple (source IP, source port, destination IP, destination port, IP protocol) after SNAT is performed is unique. The valid number is 1, 2, 4, 8, 16, 32. format: int64 - type (
str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LbSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LbSnatIpPool allows user to specify one or more IP addresses along with their subnet masks that should be used for SNAT while connecting to any of the servers in the pool.
- port_overload (
-
class
com.vmware.nsx_policy.model_client.LbSnatIpElement(ip_address=None, prefix_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_address (
str) – Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160 format: address-or-block-or-range - prefix_length (
longorNone) – Subnet prefix length should be not specified if there is only one single IP address or IP range. format: int64
- ip_address (
-
class
com.vmware.nsx_policy.model_client.LbSnatIpPool(ip_addresses=None, port_overload=None, type='LbSnatIpPool')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofLbSnatIpElement) – If an IP range is specified, the range may contain no more than 64 IP addresses. - port_overload (
longorNone) – Both SNAT automap and SNAT IP list modes support port overloading which allows the same SNAT IP and port to be used for multiple backend connections as long as the tuple (source IP, source port, destination IP, destination port, IP protocol) after SNAT is performed is unique. The valid number is 1, 2, 4, 8, 16, 32. format: int64 - type (
str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LbSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LbSnatIpPool allows user to specify one or more IP addresses along with their subnet masks that should be used for SNAT while connecting to any of the servers in the pool.
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.LbSnatTranslation(port_overload=None, type='LbSnatTranslation')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - port_overload (
longorNone) – Both SNAT automap and SNAT IP list modes support port overloading which allows the same SNAT IP and port to be used for multiple backend connections as long as the tuple (source IP, source port, destination IP, destination port, IP protocol) after SNAT is performed is unique. The valid number is 1, 2, 4, 8, 16, 32. format: int64 - type (
str) –Possible values are:
Load balancers may need to perform SNAT to ensure reverse traffic from the server can be received and processed by them. There are two modes: LbSnatAutoMap uses the load balancer interface IP and an ephemeral port as the source IP and port of the server side connection. LbSnatIpPool allows user to specify one or more IP addresses along with their subnet masks that should be used for SNAT while connecting to any of the servers in the pool.
-
TYPE_LBSNATAUTOMAP= 'LbSnatAutoMap'¶
-
TYPE_LBSNATIPPOOL= 'LbSnatIpPool'¶
- port_overload (
-
class
com.vmware.nsx_policy.model_client.LbSourceIpPersistenceProfile(ha_persistence_mirroring_enabled=None, purge=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LbSourceIpPersistenceProfile', tags=None, persistence_shared=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ha_persistence_mirroring_enabled (
boolorNone) – Persistence entries are not synchronized to the HA peer by default. - purge (
strorNone) –Possible values are:
persistence purge setting - timeout (
longorNone) – When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbPersistenceProfile.RESOURCE_TYPE_LBCOOKIEPERSISTENCEPROFILELbPersistenceProfile.RESOURCE_TYPE_LBSOURCEIPPERSISTENCEPROFILE
Source-ip persistence ensures all connections from a client (identified by IP address) are sent to the same backend server for a specified period. Cookie persistence allows related client connections, identified by the same cookie in HTTP requests, to be redirected to the same server.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - persistence_shared (
boolorNone) – If persistence shared flag is not set in the cookie persistence profile bound to a virtual server, it defaults to cookie persistence that is private to each virtual server and is qualified by the pool. This is accomplished by load balancer inserting a cookie with name in the format <name>.<virtual_server_id>.<pool_id>. If persistence shared flag is set in the cookie persistence profile, in cookie insert mode, cookie persistence could be shared across multiple virtual servers that are bound to the same pools. The cookie name would be changed to <name>.<profile-id>.<pool-id>. If persistence shared flag is not set in the sourceIp persistence profile bound to a virtual server, each virtual server that the profile is bound to maintains its own private persistence table. If persistence shared flag is set in the sourceIp persistence profile, all virtual servers the profile is bound to share the same persistence table.
-
PURGE_FULL= 'FULL'¶
-
PURGE_NO_PURGE= 'NO_PURGE'¶
- ha_persistence_mirroring_enabled (
-
class
com.vmware.nsx_policy.model_client.LbSslCipherAndProtocolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, ciphers=None, protocols=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ciphers (
listofLbSslCipherInfo) – List of SSL ciphers - protocols (
listofLbSslProtocolInfo) – List of SSL protocols
- links (
-
class
com.vmware.nsx_policy.model_client.LbSslCipherInfo(cipher=None, cipher_group_labels=None, is_default=None, is_secure=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSSL cipher
Tip
The arguments are used to initialize data attributes with the same names.
-
CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHER_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHER_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHER_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHER_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHER_ECDHE_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHER_ECDHE_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHER_ECDHE_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHER_ECDHE_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHER_ECDH_ECDSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHER_ECDH_RSA_WITH_AES_128_CBC_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHER_ECDH_RSA_WITH_AES_128_GCM_SHA256= 'TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHER_ECDH_RSA_WITH_AES_256_CBC_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384'¶
-
CIPHER_ECDH_RSA_WITH_AES_256_GCM_SHA384= 'TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384'¶
-
CIPHER_GROUP_LABELS_BALANCED= 'BALANCED'¶
-
CIPHER_GROUP_LABELS_CUSTOM= 'CUSTOM'¶
-
CIPHER_GROUP_LABELS_HIGH_COMPATIBILITY= 'HIGH_COMPATIBILITY'¶
-
CIPHER_GROUP_LABELS_HIGH_SECURITY= 'HIGH_SECURITY'¶
-
CIPHER_RSA_WITH_3DES_EDE_CBC_SHA= 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'¶
-
CIPHER_RSA_WITH_AES_128_CBC_SHA= 'TLS_RSA_WITH_AES_128_CBC_SHA'¶
-
CIPHER_RSA_WITH_AES_128_CBC_SHA256= 'TLS_RSA_WITH_AES_128_CBC_SHA256'¶
-
CIPHER_RSA_WITH_AES_128_GCM_SHA256= 'TLS_RSA_WITH_AES_128_GCM_SHA256'¶
-
CIPHER_RSA_WITH_AES_256_CBC_SHA= 'TLS_RSA_WITH_AES_256_CBC_SHA'¶
-
CIPHER_RSA_WITH_AES_256_CBC_SHA256= 'TLS_RSA_WITH_AES_256_CBC_SHA256'¶
-
CIPHER_RSA_WITH_AES_256_GCM_SHA384= 'TLS_RSA_WITH_AES_256_GCM_SHA384'¶
-
-
class
com.vmware.nsx_policy.model_client.LbSslProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLoad balancer abstract SSL profile
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- links (
-
class
com.vmware.nsx_policy.model_client.LbSslProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbSslProfile) – paginated list of load balancer SSL profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LbSslProtocolInfo(is_default=None, is_secure=None, protocol=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSSL protocol
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_default (
bool) – Default SSL protocol flag - is_secure (
bool) – Secure/insecure SSL protocol flag - protocol (
str) –Possible values are:
LbSslProtocolInfo.PROTOCOL_SSL_V2LbSslProtocolInfo.PROTOCOL_SSL_V3LbSslProtocolInfo.PROTOCOL_TLS_V1LbSslProtocolInfo.PROTOCOL_TLS_V1_1LbSslProtocolInfo.PROTOCOL_TLS_V1_2
SSL protocol
-
PROTOCOL_SSL_V2= 'SSL_V2'¶
-
PROTOCOL_SSL_V3= 'SSL_V3'¶
-
PROTOCOL_TLS_V1= 'TLS_V1'¶
-
PROTOCOL_TLS_V1_1= 'TLS_V1_1'¶
-
PROTOCOL_TLS_V1_2= 'TLS_V1_2'¶
- is_default (
-
class
com.vmware.nsx_policy.model_client.LbStatisticsCounter(bytes_in=None, bytes_in_rate=None, bytes_out=None, bytes_out_rate=None, current_session_rate=None, current_sessions=None, http_request_rate=None, http_requests=None, max_sessions=None, packets_in=None, packets_in_rate=None, packets_out=None, packets_out_rate=None, source_ip_persistence_entry_size=None, total_sessions=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - bytes_in (
long) – Number of bytes in format: int64 - bytes_in_rate (
floatorNone) – The average number of inbound bytes per second, the number is averaged over the last 5 one-second intervals. - bytes_out (
long) – Number of bytes out format: int64 - bytes_out_rate (
floatorNone) – The average number of outbound bytes per second, the number is averaged over the last 5 one-second intervals. - current_session_rate (
floatorNone) – The average number of current sessions per second, the number is averaged over the last 5 one-second intervals. - current_sessions (
long) – Number of current sessions format: int64 - http_request_rate (
floatorNone) – The average number of http requests per second, the number is averaged over the last 5 one-second intervals. - http_requests (
longorNone) – The total number of http requests. format: int64 - max_sessions (
long) – Number of maximum sessions format: int64 - packets_in (
longorNone) – Number of packets in format: int64 - packets_in_rate (
floatorNone) – The average number of inbound packets per second, the number is averaged over the last 5 one-second intervals. - packets_out (
longorNone) – Number of packets out format: int64 - packets_out_rate (
floatorNone) – The average number of outbound packets per second, the number is averaged over the last 5 one-second intervals. - source_ip_persistence_entry_size (
longorNone) – Number of source IP persistence entries format: int64 - total_sessions (
long) – Number of total sessions format: int64
- bytes_in (
-
class
com.vmware.nsx_policy.model_client.LbTcpHeaderCondition(source_port=None, inverse=None, type='LbTcpHeaderCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match TCP header fields of HTTP messages. Currently, only the TCP source port is supported. Ports can be expressed as a single port number like 80, or a port range like 1024-1030.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - source_port (
str) – TCP source port of HTTP message format: port-or-range - inverse (
boolorNone) – A flag to indicate whether reverse the match result of this condition - type (
str) –Possible values are:
LbRuleCondition.TYPE_LBHTTPREQUESTMETHODCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURICONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTURIARGUMENTSCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTVERSIONCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTHEADERCONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTCOOKIECONDITIONLbRuleCondition.TYPE_LBHTTPREQUESTBODYCONDITIONLbRuleCondition.TYPE_LBHTTPRESPONSEHEADERCONDITIONLbRuleCondition.TYPE_LBTCPHEADERCONDITIONLbRuleCondition.TYPE_LBIPHEADERCONDITIONLbRuleCondition.TYPE_LBVARIABLECONDITIONLbRuleCondition.TYPE_LBHTTPSSLCONDITION
Type of load balancer rule condition
- source_port (
-
class
com.vmware.nsx_policy.model_client.LbTcpMonitor(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - receive (
strorNone) – Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported. - send (
strorNone) – If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent. - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- receive (
-
class
com.vmware.nsx_policy.model_client.LbTcpProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, fin_wait2_timeout=None, max_syn_retransmissions=None, nagle_algorithm_enabled=None, receive_window_size=None, transmit_window_size=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTCP profile allows customization of TCP stack behavior for each application. As TCP connections are terminated (or initiated) on the load balancer only for L7 virtual servers, TCP profiles are applicable only to them. As the desired TCP characteristics (e.g. Rx/Tx buffers) may be different for client (typically on WAN) and server (typically on LAN) sides, two separate profiles can be bound to virtual server, one for client-side (LbVirtualServer.client_tcp_profile_id) and another for server-side (LbVirtualServer.server_tcp_profile_id).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - fin_wait2_timeout (
longorNone) – If the field is not specified, the load balancer will use the default setting per load balancer service flavor. format: int64 - max_syn_retransmissions (
longorNone) – If the field is not specified, the load balancer will use the default setting per load balancer service flavor. format: int64 - nagle_algorithm_enabled (
boolorNone) – Setting this option to enable or disable Nagle’s algorithm. - receive_window_size (
longorNone) – If the field is not specified, the load balancer will use the default setting per load balancer service flavor. format: int64 - transmit_window_size (
longorNone) – If the field is not specified, the load balancer will use the default setting per load balancer service flavor. format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.LbTcpProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbTcpProfile) – Paginated list of load balancer TCP profiles
- links (
-
class
com.vmware.nsx_policy.model_client.LbUdpMonitor(receive=None, send=None, fall_count=None, interval=None, monitor_port=None, rise_count=None, timeout=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - receive (
str) – Expected data, can be anywhere in the response and it has to be a string, regular expressions are not supported. UDP healthcheck is considered failed if there is no server response within the timeout period. - send (
str) – The data to be sent to the monitored server. - fall_count (
longorNone) – num of consecutive checks must fail before marking it down format: int64 - interval (
longorNone) – the frequency at which the system issues the monitor check (in second) format: int64 - monitor_port (
strorNone) – If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. format: port-or-range - rise_count (
longorNone) – num of consecutive checks must pass before marking it up format: int64 - timeout (
longorNone) – the number of seconds the target has in which to respond to the monitor request format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITOR
Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- receive (
-
class
com.vmware.nsx_policy.model_client.LbVariableAssignmentAction(variable_name=None, variable_value=None, type='LbVariableAssignmentAction')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis action is used to create a new variable and assign value to it. One action can be used to create one variable. To create multiple variables, multiple actions must be defined. The variables can be used by LbVariableCondition, etc.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - variable_name (
str) – Name of the variable to be assigned - variable_value (
str) – Value of variable - type (
str) –Possible values are:
LbRuleAction.TYPE_LBHTTPREQUESTURIREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREJECTACTIONLbRuleAction.TYPE_LBHTTPREDIRECTACTIONLbRuleAction.TYPE_LBSELECTPOOLACTIONLbRuleAction.TYPE_LBSELECTSERVERACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERREWRITEACTIONLbRuleAction.TYPE_LBHTTPREQUESTHEADERDELETEACTIONLbRuleAction.TYPE_LBHTTPRESPONSEHEADERDELETEACTIONLbRuleAction.TYPE_LBVARIABLEASSIGNMENTACTION
Type of load balancer rule action
- variable_name (
-
class
com.vmware.nsx_policy.model_client.LbVariableCondition(case_sensitive=None, match_type=None, variable_name=None, variable_value=None, inverse=None, type='LbVariableCondition')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis condition is used to match variable’s name and value at all phases. The variables could be captured from REGEX or assigned by LbVariableAssignmentAction or system embedded variable. Varialbe_name and variable_value should be matched at the same time.
Tip
The arguments are used to initialize data attributes with the same names.
-
MATCH_TYPE_CONTAINS= 'CONTAINS'¶
-
MATCH_TYPE_ENDS_WITH= 'ENDS_WITH'¶
-
MATCH_TYPE_EQUALS= 'EQUALS'¶
-
MATCH_TYPE_REGEX= 'REGEX'¶
-
MATCH_TYPE_STARTS_WITH= 'STARTS_WITH'¶
-
-
class
com.vmware.nsx_policy.model_client.LbVirtualServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, access_log_enabled=None, application_profile_id=None, client_ssl_profile_binding=None, client_tcp_profile_id=None, default_pool_member_port=None, default_pool_member_ports=None, enabled=None, ip_address=None, ip_protocol=None, max_concurrent_connections=None, max_new_connection_rate=None, persistence_profile_id=None, pool_id=None, port=None, ports=None, rule_ids=None, server_ssl_profile_binding=None, server_tcp_profile_id=None, sorry_pool_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - access_log_enabled (
boolorNone) – Whether access log is enabled - application_profile_id (
str) – The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LbFastTCPProfile, LbFastUDPProfile and LbHttpProfile, etc are supported. - client_ssl_profile_binding (
ClientSslProfileBindingorNone) – The setting is used when load balancer acts as an SSL server and terminating the client SSL connection - client_tcp_profile_id (
strorNone) – Only L7 virtual server could be configured with customized client side TCP profile. - default_pool_member_port (
strorNone) – This is a deprecated property, please use ‘default_pool_member_ports’ instead. If default_pool_member_port is configured and default_pool_member_ports are not specified, both default_pool_member_port and default_pool_member_ports in response payload would return the same port value. If both are specified, default_pool_member_ports setting would take effect with higher priority. format: port-or-range - default_pool_member_ports (
listofstrorNone) – If default_pool_member_ports are configured, both default_pool_member_port and default_pool_member_ports in the response payload would include port settings, notice that the value of default_pool_member_port is the first element of default_pool_member_ports. format: port-or-range - enabled (
boolorNone) – whether the virtual server is enabled - ip_address (
str) – virtual server IP address format: ip - ip_protocol (
strorNone) –Possible values are:
Assigned Internet Protocol in IP header, TCP, UDP are supported. - max_concurrent_connections (
longorNone) – To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited. format: int64 - max_new_connection_rate (
longorNone) – To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited. format: int64 - persistence_profile_id (
strorNone) – Persistence profile is used to allow related client connections to be sent to the same backend server. - pool_id (
strorNone) – The server pool(LbPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application. - port (
strorNone) – This is a deprecated property, please use ‘ports’ instead. Port setting could be single port for both L7 mode and L4 mode. For L4 mode, a single port range is also supported. The port setting could be a single port or port range such as "80", "1234-1236". If port is configured and ports are not specified, both port and ports in response payload would return the same port value. If both port and ports are configured, ports setting would take effect with higher priority. format: port-or-range - ports (
listofstrorNone) – Port setting could be a single port for both L7 mode and L4 mode. For L4 mode, multiple ports or port ranges are also supported such as "80", "443", "1234-1236". If ports is configured, both port and ports in the response payload would include port settings, notice that the port field value is the first element of ports. format: port-or-range - rule_ids (
listofstrorNone) – Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LbHttpProfile. - server_ssl_profile_binding (
ServerSslProfileBindingorNone) – The setting is used when load balancer acts as an SSL client and establishing a connection to the backend server. - server_tcp_profile_id (
strorNone) – Only L7 virtual server could be configured with customized server side TCP profile. - sorry_pool_id (
strorNone) – When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool.
-
IP_PROTOCOL_TCP= 'TCP'¶
-
IP_PROTOCOL_UDP= 'UDP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LbVirtualServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbVirtualServer) – paginated list of virtual servers
- links (
-
class
com.vmware.nsx_policy.model_client.LbVirtualServerStatistics(last_update_timestamp=None, statistics=None, virtual_server_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - last_update_timestamp (
longorNone) – Timestamp when the data was last updated format: int64 - statistics (
LbStatisticsCounter) – Virtual server statistics counter - virtual_server_id (
str) – load balancer virtual server identifier
- last_update_timestamp (
-
class
com.vmware.nsx_policy.model_client.LbVirtualServerStatisticsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbVirtualServerStatistics) – paginated statistics list of virtual servers
- links (
-
class
com.vmware.nsx_policy.model_client.LbVirtualServerStatus(last_update_timestamp=None, status=None, virtual_server_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - last_update_timestamp (
longorNone) – Timestamp when the data was last updated. format: int64 - status (
strorNone) –Possible values are:
LbVirtualServerStatus.STATUS_UPLbVirtualServerStatus.STATUS_PARTIALLY_UPLbVirtualServerStatus.STATUS_PRIMARY_DOWNLbVirtualServerStatus.STATUS_DOWNLbVirtualServerStatus.STATUS_DETACHEDLbVirtualServerStatus.STATUS_DISABLEDLbVirtualServerStatus.STATUS_UNKNOWN
UP means that all primary members in default pool are in UP status. For L7 virtual server, if there is no default pool, the virtual server would be treated as UP. PARTIALLY_UP means that some(not all) primary members in default pool are in UP status. The size of these active primary members should be larger than or equal to the certain number(min_active_members) which is defined in LbPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members in default pool are in UP status but backup members are in UP status, the connections would be dispatched to backup members. DOWN means that all primary and backup members are in DOWN status. DETACHED means that the virtual server is not bound to any service. DISABLED means that the admin state of the virtual server is disabled. UNKOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working).
- virtual_server_id (
str) – load balancer virtual server identifier
-
STATUS_DETACHED= 'DETACHED'¶
-
STATUS_DISABLED= 'DISABLED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_PARTIALLY_UP= 'PARTIALLY_UP'¶
-
STATUS_PRIMARY_DOWN= 'PRIMARY_DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- last_update_timestamp (
-
class
com.vmware.nsx_policy.model_client.LbVirtualServerStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLbVirtualServerStatus) – paginated status list of virtual servers
- links (
-
class
com.vmware.nsx_policy.model_client.License(links=None, schema=None, self_=None, capacity_type=None, description=None, expiry=None, features=None, is_eval=None, is_expired=None, is_mh=None, license_key=None, product_name=None, product_version=None, quantity=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructlicense properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - capacity_type (
strorNone) –Possible values are:
license metricThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- description (
strorNone) – license edition This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - expiry (
longorNone) – date that license expires format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - features (
strorNone) – semicolon delimited feature list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_eval (
boolorNone) – true for evalution license This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_expired (
boolorNone) – whether the license has expired This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_mh (
boolorNone) – multi-hypervisor support This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - license_key (
strorNone) – license key - product_name (
strorNone) – product name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - product_version (
strorNone) – product version This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - quantity (
longorNone) – license capacity; 0 for unlimited format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
CAPACITY_TYPE_CPU= 'CPU'¶
-
CAPACITY_TYPE_USER= 'USER'¶
-
CAPACITY_TYPE_VM= 'VM'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LicensesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLicenses queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLicenseorNone) – Licenses Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase class for list results from collections
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LldpHostSwitchProfile(send_enabled=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LldpHostSwitchProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost Switch for LLDP
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - send_enabled (
bool) – Enabled or disabled sending LLDP packets - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- send_enabled (
-
class
com.vmware.nsx_policy.model_client.LoadBalancerAllocationPool(allocation_size=None, allocation_pool_type='LoadBalancerAllocationPool')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocation_size (
str) –Possible values are:
LoadBalancerAllocationPool.ALLOCATION_SIZE_SMALLLoadBalancerAllocationPool.ALLOCATION_SIZE_MEDIUMLoadBalancerAllocationPool.ALLOCATION_SIZE_LARGE
To address varied customer performance and scalability requirements, different sizes for load balancer service are supported: SMALL, MEDIUM and LARGE, each with its own set of resource and performance. Specify size of load balancer service which you will bind to TIER1 router.
- allocation_pool_type (
str) –Possible values are:
Types of logical router allocation pool based on services
-
ALLOCATION_SIZE_LARGE= 'LARGE'¶
-
ALLOCATION_SIZE_MEDIUM= 'MEDIUM'¶
-
ALLOCATION_SIZE_SMALL= 'SMALL'¶
- allocation_size (
-
class
com.vmware.nsx_policy.model_client.LocaleServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSite specific configuration of Tier0 in multi-site scenario
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LocaleServicesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of LocaleServices
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLocaleServices) – LocaleServices results
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalDhcpServer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, dhcp_profile_id=None, ipv4_dhcp_server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - attached_logical_port_id (
strorNone) – id of attached logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dhcp_profile_id (
str) – dhcp profile uuid - ipv4_dhcp_server (
IPv4DhcpServer) – dhcp server for ipv4 addresses
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalDhcpServerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalDhcpServer) – paginated list of dhcp servers
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_bindings=None, admin_state=None, attachment=None, extra_configs=None, init_state=None, logical_switch_id=None, switching_profile_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - address_bindings (
listofPacketAddressClassifierorNone) – Address bindings for logical port - admin_state (
str) –Possible values are:
Represents Desired state of the logical port - attachment (
LogicalPortAttachmentorNone) – Logical port attachment - extra_configs (
listofExtraConfigorNone) – This property could be used for vendor specific configuration in key value string pairs. Logical port setting will override logical switch setting if the same key was set on both logical switch and logical port. - init_state (
strorNone) –Possible values are:
Set initial state when a new logical port is created. ‘UNBLOCKED_VLAN’ means new port will be unblocked on traffic in creation, also VLAN will be set with corresponding logical switch setting.
- logical_switch_id (
str) – Id of the Logical switch that this port belongs to. - switching_profile_ids (
listofSwitchingProfileTypeIdEntryorNone) –
-
ADMIN_STATE_DOWN= 'DOWN'¶
-
ADMIN_STATE_UP= 'UP'¶
-
INIT_STATE_VLAN= 'UNBLOCKED_VLAN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalPortAttachment(attachment_type=None, context=None, id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical port attachment
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - attachment_type (
strorNone) –Possible values are:
LogicalPortAttachment.ATTACHMENT_TYPE_VIFLogicalPortAttachment.ATTACHMENT_TYPE_LOGICALROUTERLogicalPortAttachment.ATTACHMENT_TYPE_BRIDGEENDPOINTLogicalPortAttachment.ATTACHMENT_TYPE_DHCP_SERVICELogicalPortAttachment.ATTACHMENT_TYPE_METADATA_PROXYLogicalPortAttachment.ATTACHMENT_TYPE_L2VPN_SESSION
Indicates the type of logical port attachment. By default it is Virtual Machine interface (VIF)
- context (
vmware.vapi.struct.VapiStructorNone) – Extra context data for the attachment When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inAttachmentContext. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inAttachmentContext. - id (
str) – Identifier of the interface attached to the logical port
-
ATTACHMENT_TYPE_BRIDGEENDPOINT= 'BRIDGEENDPOINT'¶
-
ATTACHMENT_TYPE_DHCP_SERVICE= 'DHCP_SERVICE'¶
-
ATTACHMENT_TYPE_L2VPN_SESSION= 'L2VPN_SESSION'¶
-
ATTACHMENT_TYPE_LOGICALROUTER= 'LOGICALROUTER'¶
-
ATTACHMENT_TYPE_METADATA_PROXY= 'METADATA_PROXY'¶
-
ATTACHMENT_TYPE_VIF= 'VIF'¶
- attachment_type (
-
class
com.vmware.nsx_policy.model_client.LogicalPortListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical port queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalPortorNone) – LogicalPort Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMacAddressCsvListResult(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalPortMacTableCsvEntryorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMacAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_port_id=None, results=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_port_id (
strorNone) – The id of the logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalPortMacTableEntryorNone) – - transport_node_id (
strorNone) – Transport node identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMacTableCsvEntry(mac_address=None, mac_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - mac_address (
str) – The MAC address - mac_type (
str) –Possible values are:
The type of the MAC address
-
MAC_TYPE_LEARNED= 'LEARNED'¶
-
MAC_TYPE_STATIC= 'STATIC'¶
- mac_address (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMacTableEntry(mac_address=None, mac_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - mac_address (
str) – The MAC address - mac_type (
str) –Possible values are:
The type of the MAC address
-
MAC_TYPE_LEARNED= 'LEARNED'¶
-
MAC_TYPE_STATIC= 'STATIC'¶
- mac_address (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMirrorDestination(port_ids=None, resource_type='LogicalPortMirrorDestination')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - port_ids (
listofstr) – Destination logical port identifier list. - resource_type (
str) –Possible values are:
MirrorDestination.RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_PNICMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_IPMIRRORDESTINATION
Resource types of mirror destination
- port_ids (
-
class
com.vmware.nsx_policy.model_client.LogicalPortMirrorSource(port_ids=None, resource_type='LogicalPortMirrorSource')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - port_ids (
listofstr) – Source logical port identifier list - resource_type (
str) –Possible values are:
MirrorSource.RESOURCE_TYPE_LOGICALPORTMIRRORSOURCEMirrorSource.RESOURCE_TYPE_PNICMIRRORSOURCEMirrorSource.RESOURCE_TYPE_VLANMIRRORSOURCEMirrorSource.RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE
Resource types of mirror source
- port_ids (
-
class
com.vmware.nsx_policy.model_client.LogicalRouter(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, advanced_config=None, allocation_profile=None, edge_cluster_id=None, edge_cluster_member_indices=None, failover_mode=None, firewall_sections=None, high_availability_mode=None, preferred_edge_cluster_member_index=None, router_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - advanced_config (
LogicalRouterConfigorNone) – Contains config properties for tier0 routers - allocation_profile (
EdgeClusterMemberAllocationProfileorNone) – Configurations options to auto allocate edge cluster members for logical router. Auto allocation is supported only for TIER1 and pick least utilized member post current assignment for next allocation. - edge_cluster_id (
strorNone) – Used for tier0 routers - edge_cluster_member_indices (
listoflongorNone) – For stateful services, the logical router should be associated with edge cluster. For TIER 1 logical router, for manual placement of service router within the cluster, edge cluster member indices needs to be provided else same will be auto-allocated. You can provide maximum two indices for HA ACTIVE_STANDBY. For TIER0 logical router this property is no use and placement is derived from logical router uplink or loopback port. format: int64 - failover_mode (
strorNone) –Possible values are:
Determines the behavior when a logical router instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property must not be populated unless the high_availability_mode property is set to ACTIVE_STANDBY. If high_availability_mode property is set to ACTIVE_STANDBY and this property is not specified then default will be NON_PREEMPTIVE.
- firewall_sections (
listofResourceReferenceorNone) – List of Firewall sections related to Logical Router. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - high_availability_mode (
strorNone) –Possible values are:
High availability mode - preferred_edge_cluster_member_index (
longorNone) – Used for tier0 routers only format: int64 - router_type (
str) –Possible values are:
Type of Logical Router
-
FAILOVER_MODE_NON_PREEMPTIVE= 'NON_PREEMPTIVE'¶
-
FAILOVER_MODE_PREEMPTIVE= 'PREEMPTIVE'¶
-
HIGH_AVAILABILITY_MODE_ACTIVE= 'ACTIVE_ACTIVE'¶
-
HIGH_AVAILABILITY_MODE_STANDBY= 'ACTIVE_STANDBY'¶
-
ROUTER_TYPE_TIER0= 'TIER0'¶
-
ROUTER_TYPE_TIER1= 'TIER1'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterCentralizedServicePort(enable_netx=None, linked_logical_switch_port_id=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterCentralizedServicePort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis port can be configured on both TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enable_netx (
boolorNone) – Port is exclusively used for N-S service insertion - linked_logical_switch_port_id (
ResourceReferenceorNone) – Reference to the logical switch port to connect to - subnets (
listofIPSubnet) – Logical router port subnets - urpf_mode (
strorNone) –Possible values are:
LogicalRouterCentralizedServicePort.URPF_MODE_NONELogicalRouterCentralizedServicePort.URPF_MODE_STRICT
Unicast Reverse Path Forwarding mode - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
-
URPF_MODE_NONE= 'NONE'¶
-
URPF_MODE_STRICT= 'STRICT'¶
- enable_netx (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterConfig(external_transit_networks=None, ha_vip_configs=None, internal_transit_network=None, transport_zone_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - external_transit_networks (
listofstrorNone) – CIDR block defining tier0 to tier1 links format: ipv4-cidr-block - ha_vip_configs (
listofHaVipConfigorNone) – This configuration can be defined only for Active-Standby LogicalRouter to provide | redundancy. For mulitple uplink ports, multiple HaVipConfigs must be defined | and each config will pair exactly two uplink ports. The VIP will move and will | always be owned by the Active node. Note - when HaVipConfig[s] are defined, | configuring dynamic-routing is disallowed. - internal_transit_network (
strorNone) – CIDR block defining Service router to distributed router links format: ipv4-cidr-block - transport_zone_id (
strorNone) – Transport zone of the logical router. If specified then all downlink switches should belong to this transport zone and an error will be thrown if transport zone of the downlink switch doesn’t match with this transport zone. All internal and external transit switches will be created in this transport zone.
- external_transit_networks (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterDownLinkPort(linked_logical_switch_port_id=None, mac_address=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterDownLinkPort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - linked_logical_switch_port_id (
ResourceReferenceorNone) – Reference to the logical switch port to connect to - mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofIPSubnet) – Logical router port subnets - urpf_mode (
strorNone) –Possible values are:
Unicast Reverse Path Forwarding mode - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
-
URPF_MODE_NONE= 'NONE'¶
-
URPF_MODE_STRICT= 'STRICT'¶
- linked_logical_switch_port_id (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterIPTunnelPort(admin_state=None, subnets=None, vpn_session_id=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterIPTunnelPort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical router IP tunnel port.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_state (
strorNone) –Possible values are:
Admin state of port.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- subnets (
listofIPSubnetorNone) – Tunnel port subnets. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vpn_session_id (
strorNone) – Associated VPN session identifier. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
-
ADMIN_STATE_DOWN= 'DOWN'¶
-
ADMIN_STATE_UP= 'UP'¶
- admin_state (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterLinkPortOnTIER0(linked_logical_router_port_id=None, mac_address=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLinkPortOnTIER0', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis port can be configured only on a TIER0 LogicalRouter. Create an empty port to generate an id. Use this id in the linked_logical_router_port_id on LogicalRouterLinkPortOnTIER1 on TIER1 logical router.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - linked_logical_router_port_id (
strorNone) – Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 logical router This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofIPSubnetorNone) – Logical router port subnets This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
- linked_logical_router_port_id (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterLinkPortOnTIER1(edge_cluster_member_index=None, linked_logical_router_port_id=None, mac_address=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLinkPortOnTIER1', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis port can be configured only on a TIER1 LogicalRouter. Use the id of the LogicalRouterLinkPortOnTIER0 from TIER0 logical router to set the linked_logical_router_port_id on the port on TIER1 logical router.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - edge_cluster_member_index (
listoflongorNone) – Please use logical router API to pass edge cluster members indexes manually. format: int64 - linked_logical_router_port_id (
ResourceReferenceorNone) – Reference of LogicalRouterLinkPortOnTIER0 of TIER0 logical router to connect this TIER1 logical router outwards. - mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofIPSubnetorNone) – Logical router port subnets This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
- edge_cluster_member_index (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalRouter) – Logical router list results
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterLoopbackPort(edge_cluster_member_index=None, subnets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterLoopbackPort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - edge_cluster_member_index (
listoflong) – Member index of the edge node on the cluster format: int64 - subnets (
listofIPSubnet) – Loopback port subnets - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
- edge_cluster_member_index (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterPort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
-
RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT= 'LogicalRouterCentralizedServicePort'¶
-
RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORT= 'LogicalRouterDownLinkPort'¶
-
RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORT= 'LogicalRouterIPTunnelPort'¶
-
RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0= 'LogicalRouterLinkPortOnTIER0'¶
-
RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1= 'LogicalRouterLinkPortOnTIER1'¶
-
RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORT= 'LogicalRouterLoopbackPort'¶
-
RESOURCE_TYPE_LOGICALROUTERUPLINKPORT= 'LogicalRouterUpLinkPort'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortArpCsvRecord(ip=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip (
str) – The IP address format: ip - mac_address (
str) – The MAC address
- ip (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortArpEntry(ip=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip (
str) – The IP address format: ip - mac_address (
str) – The MAC address
- ip (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortArpTable(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_port_id=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_router_port_id (
str) – The ID of the logical router port - results (
listofLogicalRouterPortArpEntryorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortArpTableInCsvFormat(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalRouterPortArpCsvRecordorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortElement(element_id=None, elements=None, resource_name=None, resource_type=None, mac_address=None, subnets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical router port element extends from Element class. This class contains logical port information of logical router.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
LogicalRouterPortElement.RESOURCE_TYPE_VMELEMENTLogicalRouterPortElement.RESOURCE_TYPE_GROUPELEMENTLogicalRouterPortElement.RESOURCE_TYPE_PROCESSELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTLogicalRouterPortElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTLogicalRouterPortElement.RESOURCE_TYPE_HOSTNODEELEMENTLogicalRouterPortElement.RESOURCE_TYPE_EDGENODEELEMENTLogicalRouterPortElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTResource type of the element
- mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofstrorNone) – Logical router port subnets This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterPortListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – Logical router port list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inLogicalRouterPort. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inLogicalRouterPort.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterRouteCsvRecord(admin_distance=None, logical_router_port_id=None, lr_component_id=None, lr_component_type=None, network=None, next_hop=None, route_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_distance (
longorNone) – The admin distance of the next hop format: int64 - logical_router_port_id (
strorNone) – The id of the logical router port which is used as the next hop - lr_component_id (
strorNone) – Logical router component(Service Router/Distributed Router) id - lr_component_type (
strorNone) – Logical router component(Service Router/Distributed Router) type - network (
str) – CIDR network address format: ipv4-cidr-block - next_hop (
strorNone) – The IP of the next hop format: ip - route_type (
str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
- admin_distance (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterRouteEntry(admin_distance=None, logical_router_port_id=None, lr_component_id=None, lr_component_type=None, network=None, next_hop=None, route_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_distance (
longorNone) – The admin distance of the next hop format: int64 - logical_router_port_id (
strorNone) – The id of the logical router port which is used as the next hop - lr_component_id (
strorNone) – Logical router component(Service Router/Distributed Router) id - lr_component_type (
strorNone) – Logical router component(Service Router/Distributed Router) type - network (
str) – CIDR network address format: ipv4-cidr-block - next_hop (
strorNone) – The IP address of the next hop format: ip - route_type (
str) – Route type (USER, CONNECTED, NSX_INTERNAL,..)
- admin_distance (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterRouteTable(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_router_id=None, logical_router_name=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_router_id (
str) – The id of the logical router - logical_router_name (
strorNone) – Name of the logical router This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalRouterRouteEntryorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterRouteTableInCsvFormat(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalRouterRouteCsvRecordorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.LogicalRouterUpLinkPort(edge_cluster_member_index=None, linked_logical_switch_port_id=None, mac_address=None, mtu=None, subnets=None, urpf_mode=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='LogicalRouterUpLinkPort', tags=None, logical_router_id=None, service_bindings=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - edge_cluster_member_index (
listoflong) – Member index of the edge node on the cluster format: int64 - linked_logical_switch_port_id (
ResourceReferenceorNone) – Reference to the logical switch port to connect to - mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mtu (
longorNone) – Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit. format: int64 - subnets (
listofIPSubnet) – Logical router port subnets - urpf_mode (
strorNone) –Possible values are:
Unicast Reverse Path Forwarding mode - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERUPLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERDOWNLINKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER0LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLINKPORTONTIER1LogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERLOOPBACKPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERIPTUNNELPORTLogicalRouterPort.RESOURCE_TYPE_LOGICALROUTERCENTRALIZEDSERVICEPORT
LogicalRouterUpLinkPort is allowed only on TIER0 logical router. It is the north facing port of the logical router. LogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router. This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to. LogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router. This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router. Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router. LogicalRouterDownLinkPort is for the connected subnets on the logical router. LogicalRouterLoopbackPort is a loopback port for logical router component which is placed on chosen edge cluster member. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1 logical router. Port can be connected to VLAN or overlay logical switch. Unlike downlink port it does not participate in distributed routing and hosted on all edge cluster members associated with logical router. Stateful services can be applied on this port.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
str) – Identifier for logical router on which this port is created - service_bindings (
listofServiceBindingorNone) – Service Bindings
-
URPF_MODE_NONE= 'NONE'¶
-
URPF_MODE_STRICT= 'STRICT'¶
- edge_cluster_member_index (
-
class
com.vmware.nsx_policy.model_client.LogicalService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, dhcp_relay_profile_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Resource type of the logical service - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - dhcp_relay_profile_id (
str) – dhcp relay profile referenced by the dhcp relay service
-
RESOURCE_TYPE_DHCPRELAYSERVICE= 'DhcpRelayService'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalService) – Logical router service list results
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, address_bindings=None, admin_state=None, extra_configs=None, ip_pool_id=None, mac_pool_id=None, replication_mode=None, switching_profile_ids=None, transport_zone_id=None, uplink_teaming_policy_name=None, vlan=None, vlan_trunk_spec=None, vni=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - address_bindings (
listofPacketAddressClassifierorNone) – Address bindings for the Logical switch - admin_state (
str) –Possible values are:
Represents Desired state of the Logical Switch - extra_configs (
listofExtraConfigorNone) – This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by logical ports in the logical switch. - ip_pool_id (
strorNone) – IP pool id that associated with a LogicalSwitch. - mac_pool_id (
strorNone) – Mac pool id that associated with a LogicalSwitch. - replication_mode (
strorNone) –Possible values are:
Replication mode of the Logical Switch - switching_profile_ids (
listofSwitchingProfileTypeIdEntryorNone) – - transport_zone_id (
str) – Id of the TransportZone to which this LogicalSwitch is associated - uplink_teaming_policy_name (
strorNone) – This name has to be one of the switching uplink teaming policy names listed inside the logical switch’s TransportZone. If this field is not specified, the logical switch will not have a teaming policy associated with it and the host switch’s default teaming policy will be used. - vlan (
longorNone) – This property is dedicated to VLAN based network, to set VLAN of logical network. It is mutually exclusive with ‘vlan_trunk_spec’. format: int64 - vlan_trunk_spec (
VlanTrunkSpecorNone) – This property is used for VLAN trunk specification of logical switch. It’s mutually exclusive with ‘vlan’. Also it could be set to do guest VLAN tagging in overlay network. - vni (
longorNone) – Only for OVERLAY network. A VNI will be auto-allocated from the default VNI pool if not given; otherwise the given VNI has to be inside the default pool and not used by any other LogicalSwitch. format: int32
-
ADMIN_STATE_DOWN= 'DOWN'¶
-
ADMIN_STATE_UP= 'UP'¶
-
REPLICATION_MODE_MTEP= 'MTEP'¶
-
REPLICATION_MODE_SOURCE= 'SOURCE'¶
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchElement(element_id=None, elements=None, resource_name=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical switch element extends from Element class. This class contains the information related to the logical switch.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical Switch queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalSwitchorNone) – Logical Switch Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchMirrorSource(switch_id=None, resource_type='LogicalSwitchMirrorSource')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - switch_id (
str) – Source logical switch identifier - resource_type (
str) –Possible values are:
MirrorSource.RESOURCE_TYPE_LOGICALPORTMIRRORSOURCEMirrorSource.RESOURCE_TYPE_PNICMIRRORSOURCEMirrorSource.RESOURCE_TYPE_VLANMIRRORSOURCEMirrorSource.RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE
Resource types of mirror source
- switch_id (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchPortElement(element_id=None, elements=None, resource_name=None, resource_type=None, ip_addresses=None, mac_address=None, rx_bytes=None, rx_packets=None, tx_bytes=None, tx_packets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical switch port element extends from Element class. This class contains logical port information of a logical switch.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
LogicalSwitchPortElement.RESOURCE_TYPE_VMELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_GROUPELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_PROCESSELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_HOSTNODEELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_EDGENODEELEMENTLogicalSwitchPortElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTResource type of the element
- ip_addresses (
listofstrorNone) – IP addressses of logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac_address (
strorNone) – MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rx_bytes (
listoflongorNone) – Array of bytes received format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rx_packets (
listoflongorNone) – Array of number of packets received format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tx_bytes (
listoflongorNone) – Array of bytes transmitted format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tx_packets (
listoflongorNone) – Array of number of packets transmitted format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchState(details=None, failure_code=None, failure_message=None, state=None, logical_switch_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
LogicalSwitchState.STATE_PENDINGLogicalSwitchState.STATE_IN_PROGRESSLogicalSwitchState.STATE_SUCCESSLogicalSwitchState.STATE_FAILEDLogicalSwitchState.STATE_PARTIAL_SUCCESSLogicalSwitchState.STATE_ORPHANEDLogicalSwitchState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- logical_switch_id (
strorNone) – Id of the logical switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchStateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical Switch state queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalSwitchStateorNone) – Logical Switch State Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchStatus(logical_switch_id=None, num_logical_ports=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - logical_switch_id (
strorNone) – Unique ID identifying the the Logical Switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - num_logical_ports (
longorNone) – Count of Logical Ports belonging to this switch format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- logical_switch_id (
-
class
com.vmware.nsx_policy.model_client.LogicalSwitchStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical Switch runtime status queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofLogicalSwitchStatusorNone) – LogicalSwitchStatus Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.LogicalT0RouterElement(element_id=None, elements=None, resource_name=None, resource_type=None, linking_outside=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical T0 router element extends from Element class. This class contains the information related to logical T0 router.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.LogicalT1RouterElement(element_id=None, elements=None, resource_name=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLogical T1 router element extends from Element class. This class contains the information related to logical T1 router.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.LoginCredential(credential_type='LoginCredential')¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase type for various login credential types
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: credential_type ( str) – Possible values are ‘UsernamePasswordLoginCredential’, ‘VerifiableAsymmetricLoginCredential’.
-
class
com.vmware.nsx_policy.model_client.MACAddressElement(links=None, schema=None, self_=None, revision=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMAC Address
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - mac_address (
str) – A MAC address. Must be 6 pairs of hexadecimal digits, upper or lower case, separated by colons or dashes. Examples: 01:23:45:67:89:ab, 01-23-45-67-89-AB.
- links (
-
class
com.vmware.nsx_policy.model_client.MACAddressElementListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of MAC address elements
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMACAddressElement) – MAC address element list
- links (
-
class
com.vmware.nsx_policy.model_client.MACSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, mac_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMACSet is used to group individual MAC addresses. MACSets can be used as sources and destinations in layer2 firewall rules. These can also be used as members of NSGroups.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - mac_addresses (
listofstrorNone) – MAC addresses
- links (
-
class
com.vmware.nsx_policy.model_client.MACSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMACSet) – Paged collection of MACSets
- links (
-
class
com.vmware.nsx_policy.model_client.MacAddressCsvListResult(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMacTableCsvRecordorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.MacAddressListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_switch_id=None, results=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_switch_id (
strorNone) – The id of the logical Switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMacTableEntryorNone) – - transport_node_id (
strorNone) – Transport node identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.MacLearningSpec(aging_time=None, enabled=None, limit=None, limit_policy=None, unicast_flooding_allowed=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMAC learning configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - aging_time (
longorNone) – Aging time in sec for learned MAC address format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enabled (
bool) – Allowing source MAC address learning - limit (
longorNone) – The maximum number of MAC addresses that can be learned on this port format: int32 - limit_policy (
strorNone) –Possible values are:
The policy after MAC Limit is exceeded - unicast_flooding_allowed (
boolorNone) – Allowing flooding for unlearned MAC for ingress traffic
-
LIMIT_POLICY_ALLOW= 'ALLOW'¶
-
LIMIT_POLICY_DROP= 'DROP'¶
- aging_time (
-
class
com.vmware.nsx_policy.model_client.MacManagementSwitchingProfile(mac_change_allowed=None, mac_learning=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MacManagementSwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - mac_change_allowed (
boolorNone) – Allowing source MAC address change - mac_learning (
MacLearningSpecorNone) – MAC learning configuration - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- mac_change_allowed (
-
class
com.vmware.nsx_policy.model_client.MacPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ranges=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA collection of ranges of MAC addresses
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ranges (
listofMacRange) – Array of ranges for MAC addresses
- links (
-
class
com.vmware.nsx_policy.model_client.MacPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMacPool) – MAC pool list results
- links (
-
class
com.vmware.nsx_policy.model_client.MacRange(end=None, start=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA range of MAC addresses with a start and end value
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - end (
str) – End value for MAC address range - start (
str) – Start value for MAC address range
- end (
-
class
com.vmware.nsx_policy.model_client.MacTableCsvRecord(mac_address=None, vtep_ip=None, vtep_mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - mac_address (
str) – The MAC address - vtep_ip (
strorNone) – The virtual tunnel endpoint IP address format: ip - vtep_mac_address (
strorNone) – The virtual tunnel endpoint MAC address
- mac_address (
-
class
com.vmware.nsx_policy.model_client.MacTableEntry(mac_address=None, vtep_ip=None, vtep_mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - mac_address (
str) – The MAC address - vtep_ip (
strorNone) – The virtual tunnel endpoint IP address format: ip - vtep_mac_address (
strorNone) – The virtual tunnel endpoint MAC address
- mac_address (
-
class
com.vmware.nsx_policy.model_client.ManagedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase type for resources that are managed by API clients
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- links (
-
class
com.vmware.nsx_policy.model_client.ManagementClusterNodeStatus(mgmt_cluster_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: mgmt_cluster_status ( strorNone) –Possible values are:
ManagementClusterNodeStatus.MGMT_CLUSTER_STATUS_CONNECTEDManagementClusterNodeStatus.MGMT_CLUSTER_STATUS_DISCONNECTEDManagementClusterNodeStatus.MGMT_CLUSTER_STATUS_UNKNOWN
Status of this node’s connection to the management clusterThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MGMT_CLUSTER_STATUS_CONNECTED= 'CONNECTED'¶
-
MGMT_CLUSTER_STATUS_DISCONNECTED= 'DISCONNECTED'¶
-
MGMT_CLUSTER_STATUS_UNKNOWN= 'UNKNOWN'¶
-
class
com.vmware.nsx_policy.model_client.ManagementClusterRoleConfig(type=None, api_listen_addr=None, mgmt_cluster_listen_addr=None, mgmt_plane_listen_addr=None, mpa_msg_client_info=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - type (
strorNone) –Possible values are:
ManagementClusterRoleConfig.TYPE_MANAGEMENTCLUSTERROLECONFIGType of this role configuration
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- api_listen_addr (
ServiceEndpointorNone) – The IP and port for the public API service on this node - mgmt_cluster_listen_addr (
ServiceEndpointorNone) – The IP and port for the management cluster service on this node - mgmt_plane_listen_addr (
ServiceEndpointorNone) – The IP and port for the management plane service on this node - mpa_msg_client_info (
MsgClientInfoorNone) –
-
TYPE_CONTROLLERCLUSTERROLECONFIG= 'ControllerClusterRoleConfig'¶
-
TYPE_MANAGEMENTCLUSTERROLECONFIG= 'ManagementClusterRoleConfig'¶
- type (
-
class
com.vmware.nsx_policy.model_client.ManagementClusterStatus(offline_nodes=None, online_nodes=None, required_members_for_initialization=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - offline_nodes (
listofManagementPlaneBaseNodeInfoorNone) – Current missing management plane nodes This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - online_nodes (
listofManagementPlaneBaseNodeInfoorNone) – Current alive management plane nodes This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - required_members_for_initialization (
listofClusterInitializationNodeInfoorNone) – The details of the cluster nodes required for cluster initialization This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
strorNone) –Possible values are:
ManagementClusterStatus.STATUS_INITIALIZINGManagementClusterStatus.STATUS_UNSTABLEManagementClusterStatus.STATUS_STABLEManagementClusterStatus.STATUS_UNKNOWN
The current status of the management clusterThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATUS_INITIALIZING= 'INITIALIZING'¶
-
STATUS_STABLE= 'STABLE'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UNSTABLE= 'UNSTABLE'¶
- offline_nodes (
-
class
com.vmware.nsx_policy.model_client.ManagementConfig(links=None, schema=None, self_=None, revision=None, publish_fqdns=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - publish_fqdns (
bool) – True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.
- links (
-
class
com.vmware.nsx_policy.model_client.ManagementNodeAggregateInfo(display_name=None, id=None, node_interface_properties=None, node_interface_statistics=None, node_status=None, node_status_properties=None, role_config=None, transport_nodes_connected=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_properties (
listofNodeInterfacePropertiesorNone) – Array of Node interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_interface_statistics (
listofNodeInterfaceStatisticsPropertiesorNone) – Array of Node network interface statistic properties This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - node_status (
ClusterNodeStatusorNone) – - node_status_properties (
listofNodeStatusPropertiesorNone) – Time series of the node’s system properties - role_config (
ManagementClusterRoleConfigorNone) – - transport_nodes_connected (
longorNone) –
- display_name (
-
class
com.vmware.nsx_policy.model_client.ManagementPlaneBaseNodeInfo(mgmt_cluster_listen_ip_address=None, uuid=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe basic node info of management plane node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - mgmt_cluster_listen_ip_address (
strorNone) – The IP address of MP node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - uuid (
strorNone) – Management plane node UUID This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- mgmt_cluster_listen_ip_address (
-
class
com.vmware.nsx_policy.model_client.MetadataProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attached_logical_port_id=None, crypto_protocols=None, edge_cluster_id=None, edge_cluster_member_indexes=None, metadata_server_ca_ids=None, metadata_server_url=None, secret=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - attached_logical_port_id (
strorNone) – id of attached logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - crypto_protocols (
listofstrorNone) –Possible values are:
MetadataProxy.CRYPTO_PROTOCOLS_V1MetadataProxy.CRYPTO_PROTOCOLS_V1_1MetadataProxy.CRYPTO_PROTOCOLS_V1_2
The cryptographic protocols listed here are supported by the metadata proxy. The TLSv1.1 and TLSv1.2 are supported by default.
- edge_cluster_id (
str) – edge cluster uuid - edge_cluster_member_indexes (
listoflongorNone) – If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support. format: int64 - metadata_server_ca_ids (
listofstrorNone) – The CAs referenced here must be uploaded to the truststore using the API POST /api/v1/trust-management/certificates?action=import. User needs to ensure a correct CA for this metedata server is used. The REST API can not detect a wrong CA which was used to verify a different server. If the Metadata Proxy reports an ERROR or NO_BACKUP status, user can check the metadata proxy log at transport node for a possible CA issue. - metadata_server_url (
str) – The URL in format scheme://host:port/path. Please note, the scheme supports only http and https as of now, port supports range 3000 - 9000, inclusive. - secret (
strorNone) – secret to access metadata server
-
CRYPTO_PROTOCOLS_V1= 'TLS_V1'¶
-
CRYPTO_PROTOCOLS_V1_1= 'TLS_V1_1'¶
-
CRYPTO_PROTOCOLS_V1_2= 'TLS_V1_2'¶
- links (
-
class
com.vmware.nsx_policy.model_client.MetadataProxyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofMetadataProxy) – paginated list of metadata proxies
- links (
-
class
com.vmware.nsx_policy.model_client.MgmtConnStatus(connectivity_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: connectivity_status ( strorNone) –Possible values are:
MgmtConnStatus.CONNECTIVITY_STATUS_CONNECTEDMgmtConnStatus.CONNECTIVITY_STATUS_DISCONNECTEDMgmtConnStatus.CONNECTIVITY_STATUS_UNKNOWN
Indicates the controller node’s MP channel connectivity statusThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
CONNECTIVITY_STATUS_CONNECTED= 'CONNECTED'¶
-
CONNECTIVITY_STATUS_DISCONNECTED= 'DISCONNECTED'¶
-
CONNECTIVITY_STATUS_UNKNOWN= 'UNKNOWN'¶
-
class
com.vmware.nsx_policy.model_client.MirrorDestination(resource_type='MirrorDestination')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
MirrorDestination.RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_PNICMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_IPMIRRORDESTINATION
Resource types of mirror destination-
RESOURCE_TYPE_IPMIRRORDESTINATION= 'IPMirrorDestination'¶
-
RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATION= 'LogicalPortMirrorDestination'¶
-
RESOURCE_TYPE_PNICMIRRORDESTINATION= 'PnicMirrorDestination'¶
-
class
com.vmware.nsx_policy.model_client.MirrorSource(resource_type='MirrorSource')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
MirrorSource.RESOURCE_TYPE_LOGICALPORTMIRRORSOURCEMirrorSource.RESOURCE_TYPE_PNICMIRRORSOURCEMirrorSource.RESOURCE_TYPE_VLANMIRRORSOURCEMirrorSource.RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE
Resource types of mirror source-
RESOURCE_TYPE_LOGICALPORTMIRRORSOURCE= 'LogicalPortMirrorSource'¶
-
RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE= 'LogicalSwitchMirrorSource'¶
-
RESOURCE_TYPE_PNICMIRRORSOURCE= 'PnicMirrorSource'¶
-
RESOURCE_TYPE_VLANMIRRORSOURCE= 'VlanMirrorSource'¶
-
class
com.vmware.nsx_policy.model_client.MonthlyTelemetrySchedule(day_of_month=None, hour_of_day=None, minutes=None, frequency_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - day_of_month (
long) – Day of month on which data will be collected. Specify a value between 1 through 31. format: int64 - hour_of_day (
long) – Hour at which data will be collected. Specify a value between 0 through 23. format: int64 - minutes (
longorNone) – Minute at which data will be collected. Specify a value between 0 through 59. format: int64 - frequency_type (
str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.
- day_of_month (
-
class
com.vmware.nsx_policy.model_client.MsgClientInfo(account_name=None, certificate=None, shared_secret=None, software_version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInformation about a messaging client
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - account_name (
strorNone) – Account name for the messaging client. Identifies the client on the management plane message bus. - certificate (
strorNone) – Messaging client’s certificate. Used to authenticate to the control plane messaging endpoint. - shared_secret (
strorNone) – Messaging client’s secret. Used to authenticate to the management plane messaging broker. - software_version (
strorNone) – Software version of the node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- account_name (
-
class
com.vmware.nsx_policy.model_client.MultiWidgetConfiguration(navigation=None, widgets=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='MultiWidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCombines two or more widgetconfigurations into a multi-widget
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - widgets (
listofWidgetItem) – Array of widgets that are part of the multi-widget. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- navigation (
-
class
com.vmware.nsx_policy.model_client.NSGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, member_count=None, members=None, membership_criteria=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNSGroups are recursive groupings of different NSX elements (logical and physical), typically used in policy definitions.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - member_count (
longorNone) – Count of the members added to this NSGroup format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - members (
listofNSGroupSimpleExpressionorNone) – Reference to the direct/static members of the NSGroup. Can be ID based expressions only. VirtualMachine cannot be added as a static member. - membership_criteria (
listofvmware.vapi.struct.VapiStructorNone) – List of tag or name based expressions which define the dynamic membership criteria for this NSGroup. An object must satisfy atleast one of these expressions to qualify as a member of this group. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSGroupExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSGroupExpression.
- links (
-
class
com.vmware.nsx_policy.model_client.NSGroupComplexExpression(expressions=None, resource_type='NSGroupComplexExpression')¶ Bases:
vmware.vapi.bindings.struct.VapiStructComplex expressions to represent NSGroup membership
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - expressions (
listofvmware.vapi.struct.VapiStruct) – Represents expressions which are to be logically ‘AND’ed.The array cannot contain NSGroupComplexExpression.Only NSGroupTagExpression and NSGroupSimpleExpressions are accepted. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSGroupExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSGroupExpression. - resource_type (
str) –Possible values are:
- expressions (
-
class
com.vmware.nsx_policy.model_client.NSGroupExpression(resource_type='NSGroupExpression')¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy expression for NSGroup membership
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
-
RESOURCE_TYPE_NSGROUPCOMPLEXEXPRESSION= 'NSGroupComplexExpression'¶
-
RESOURCE_TYPE_NSGROUPSIMPLEEXPRESSION= 'NSGroupSimpleExpression'¶
-
RESOURCE_TYPE_NSGROUPTAGEXPRESSION= 'NSGroupTagExpression'¶
-
-
class
com.vmware.nsx_policy.model_client.NSGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of NSGroups
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNSGroup) – NSGroup list results
- links (
-
class
com.vmware.nsx_policy.model_client.NSGroupSimpleExpression(op=None, target_property=None, target_resource=None, target_type=None, value=None, resource_type='NSGroupSimpleExpression')¶ Bases:
vmware.vapi.bindings.struct.VapiStructSimple expressions to represent NSGroup membership
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - op (
str) –Possible values are:
NSGroupSimpleExpression.OP_EQUALSNSGroupSimpleExpression.OP_CONTAINSNSGroupSimpleExpression.OP_STARTSWITH
Operator of the expression - target_property (
str) – Field of the resource on which this expression is evaluated - target_resource (
ResourceReferenceorNone) – Reference of the target. Will be populated when the property is a resource id, the op (operator) is EQUALS and populate_references is set to be true. - target_type (
str) –Possible values are:
NSGroupSimpleExpression.TARGET_TYPE_NSGROUPNSGroupSimpleExpression.TARGET_TYPE_IPSETNSGroupSimpleExpression.TARGET_TYPE_MACSETNSGroupSimpleExpression.TARGET_TYPE_LOGICALSWITCHNSGroupSimpleExpression.TARGET_TYPE_LOGICALPORTNSGroupSimpleExpression.TARGET_TYPE_VIRTUALMACHINENSGroupSimpleExpression.TARGET_TYPE_DIRECTORYGROUP
Type of the resource on which this expression is evaluated - value (
str) – Value that satisfies this expression - resource_type (
str) –Possible values are:
-
OP_CONTAINS= 'CONTAINS'¶
-
OP_EQUALS= 'EQUALS'¶
-
OP_STARTSWITH= 'STARTSWITH'¶
-
TARGET_TYPE_DIRECTORYGROUP= 'DirectoryGroup'¶
-
TARGET_TYPE_IPSET= 'IPSet'¶
-
TARGET_TYPE_LOGICALPORT= 'LogicalPort'¶
-
TARGET_TYPE_LOGICALSWITCH= 'LogicalSwitch'¶
-
TARGET_TYPE_MACSET= 'MACSet'¶
-
TARGET_TYPE_NSGROUP= 'NSGroup'¶
-
TARGET_TYPE_VIRTUALMACHINE= 'VirtualMachine'¶
- op (
-
class
com.vmware.nsx_policy.model_client.NSGroupTagExpression(scope=None, scope_op=None, tag=None, tag_op=None, target_type=None, resource_type='NSGroupTagExpression')¶ Bases:
vmware.vapi.bindings.struct.VapiStructIncludes both scope and tag attribute of Tag. The scope and tag expressions are logically ‘AND’ with each other. eg- tag.scope = "S1" AND tag.tag = ‘T1’
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - scope (
strorNone) – The tag.scope attribute of the object - scope_op (
strorNone) –Possible values are:
Operator of the scope expression eg- tag.scope = “S1”. - tag (
strorNone) – The tag.tag attribute of the object - tag_op (
strorNone) –Possible values are:
Operator of the tag expression eg- tag.tag = “Production” - target_type (
str) –Possible values are:
NSGroupTagExpression.TARGET_TYPE_LOGICALSWITCHNSGroupTagExpression.TARGET_TYPE_LOGICALPORTNSGroupTagExpression.TARGET_TYPE_VIRTUALMACHINE
Type of the resource on which this expression is evaluated - resource_type (
str) –Possible values are:
-
SCOPE_OP_EQUALS= 'EQUALS'¶
-
TAG_OP_EQUALS= 'EQUALS'¶
-
TARGET_TYPE_LOGICALPORT= 'LogicalPort'¶
-
TARGET_TYPE_LOGICALSWITCH= 'LogicalSwitch'¶
-
TARGET_TYPE_VIRTUALMACHINE= 'VirtualMachine'¶
- scope (
-
class
com.vmware.nsx_policy.model_client.NSService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, default_service=None, nsservice_element=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Networking and Security Service allows users to specify characteristics to use for matching network traffic. For example the user can specify port and protocol pair.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - default_service (
boolorNone) – The default NSServices are created in the system by default. These NSServices can’t be modified/deleted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - nsservice_element (
vmware.vapi.struct.VapiStruct) – An NSService Element that describes traffic corresponding to this NSService When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement.
- links (
-
class
com.vmware.nsx_policy.model_client.NSServiceElement(resource_type='NSServiceElement')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn NSService element that describes traffic corresponding to an NSService
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: resource_type ( str) –Possible values are:
NSServiceElement.RESOURCE_TYPE_ETHERTYPENSSERVICENSServiceElement.RESOURCE_TYPE_IPPROTOCOLNSSERVICENSServiceElement.RESOURCE_TYPE_IGMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ICMPTYPENSSERVICENSServiceElement.RESOURCE_TYPE_ALGTYPENSSERVICENSServiceElement.RESOURCE_TYPE_L4PORTSETNSSERVICE
The specific type of NSServiceElement-
RESOURCE_TYPE_ALGTYPENSSERVICE= 'ALGTypeNSService'¶
-
RESOURCE_TYPE_ETHERTYPENSSERVICE= 'EtherTypeNSService'¶
-
RESOURCE_TYPE_ICMPTYPENSSERVICE= 'ICMPTypeNSService'¶
-
RESOURCE_TYPE_IGMPTYPENSSERVICE= 'IGMPTypeNSService'¶
-
RESOURCE_TYPE_IPPROTOCOLNSSERVICE= 'IPProtocolNSService'¶
-
RESOURCE_TYPE_L4PORTSETNSSERVICE= 'L4PortSetNSService'¶
-
class
com.vmware.nsx_policy.model_client.NSServiceGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, default_service=None, members=None, service_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Networking and Security Service Group that represents a group of NSServices
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - default_service (
boolorNone) – The default NSServiceGroups are created in the system by default. These NSServiceGroups can’t be modified/deleted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - members (
listofResourceReference) – List of NSService or NSServiceGroup resources that can be added as members to an NSServiceGroup. - service_type (
strorNone) –Possible values are:
Type of the NSServiceGroupThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SERVICE_TYPE_ETHER= 'ETHER'¶
-
SERVICE_TYPE_NON_ETHER= 'NON_ETHER'¶
- links (
-
class
com.vmware.nsx_policy.model_client.NSServiceGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList result of NSServiceGroups
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNSServiceGroup) – Paged collection of NSServiceGroups
- links (
-
class
com.vmware.nsx_policy.model_client.NSServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList result of NSservices
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNSService) – Paged collection of NSServices
- links (
-
class
com.vmware.nsx_policy.model_client.NSXTConnectionInfo(edge_cluster_ids=None, password=None, thumbprint=None, transport_zone_ids=None, username=None, enforcement_point_address=None, resource_type='NSXTConnectionInfo')¶ Bases:
vmware.vapi.bindings.struct.VapiStructCredential info to connect to NSXT enforcement type
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - edge_cluster_ids (
listofstrorNone) – Edge Cluster UUIDs on NSX Manager. Edge cluster information is required for creating logical L2, L3 constructs on NSX Manager. Max 1 edge cluster ID. - password (
strorNone) – Password - thumbprint (
str) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex. - transport_zone_ids (
listofstrorNone) – Transport Zone UUIDs on NSX Manager. Transport zone information is required for creating logical L2, L3 constructs on NSX Manager. Max 1 transport zone ID. - username (
str) – UserName - enforcement_point_address (
strorNone) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be "10.192.1.1", for NSX-T manager running on custom port value can be "192.168.1.1:32789". For NSX-T manager in VMC deployments value can have url prefix eg. "192.168.1.1:5480/nsxapi" - resource_type (
str) –Possible values are:
- edge_cluster_ids (
-
class
com.vmware.nsx_policy.model_client.NSXVConnectionInfo(password=None, thumbprint=None, username=None, enforcement_point_address=None, resource_type='NSXVConnectionInfo')¶ Bases:
vmware.vapi.bindings.struct.VapiStructCredential info to connect to NSXV enforcement type
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - password (
strorNone) – Password - thumbprint (
str) – Thumbprint of EnforcementPoint. sha-256 hash represented in lower case hex. - username (
strorNone) – UserName - enforcement_point_address (
strorNone) – Value of this property could be hostname or ip. eg. For NSX-T manager running on default port the value can be "10.192.1.1", for NSX-T manager running on custom port value can be "192.168.1.1:32789". For NSX-T manager in VMC deployments value can have url prefix eg. "192.168.1.1:5480/nsxapi" - resource_type (
str) –Possible values are:
- password (
-
class
com.vmware.nsx_policy.model_client.NamedTeamingPolicy(active_list=None, policy=None, standby_list=None, name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUplink Teaming Policy with a name that can be referenced by logical switches
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - active_list (
listofUplink) – List of Uplinks used in active list - policy (
str) –Possible values are:
Teaming policy - standby_list (
listofUplinkorNone) – List of Uplinks used in standby list - name (
str) – An uplink teaming policy of a given name defined in UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in an UplinkHostSwitchProfile must be different, but a name can be shared by different UplinkHostSwitchProfiles. Different TransportNodes can use different NamedTeamingPolicies having the same name in different UplinkHostSwitchProfiles to realize an uplink teaming policy on a logical switch. An uplink teaming policy on a logical switch can be any policy defined by a user; it does not have to be a single type of FAILOVER or LOADBALANCE. It can be a combination of types, for instance, a user can define a policy with name "MyHybridTeamingPolicy" as "FAILOVER on all ESX TransportNodes and LOADBALANCE on all KVM TransportNodes". The name is the key of the teaming policy and can not be changed once assigned.
-
POLICY_FAILOVER_ORDER= 'FAILOVER_ORDER'¶
-
POLICY_LOADBALANCE_SRCID= 'LOADBALANCE_SRCID'¶
- active_list (
-
class
com.vmware.nsx_policy.model_client.NatRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, action=None, applied_tos=None, enabled=None, logging=None, logical_router_id=None, match_destination_network=None, match_service=None, match_source_network=None, nat_pass=None, rule_priority=None, translated_network=None, translated_ports=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - action (
str) –Possible values are:
NatRule.ACTION_SNATNatRule.ACTION_DNATNatRule.ACTION_NO_NATNatRule.ACTION_REFLEXIVENatRule.ACTION_NO_SNATNatRule.ACTION_NO_DNAT
valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE. All rules in a logical router are either stateless or stateful. Mix is not supported. SNAT and DNAT are stateful, can NOT be supported when the logical router is running at active-active HA mode; REFLEXIVE is stateless. NO_SNAT and NO_DNAT have no translated_fields, only match fields are supported.
- applied_tos (
listofResourceReferenceorNone) – Holds the list of LogicalRouterPort Ids that a NAT rule can be applied to. The LogicalRouterPort used must belong to the same LogicalRouter for which the NAT Rule is created. As of now a NAT rule can only have a single LogicalRouterPort as applied_tos. When applied_tos is not set, the NAT rule is applied to all LogicalRouterPorts beloging to the LogicalRouter. - enabled (
boolorNone) – enable/disable the rule - logging (
boolorNone) – enable/disable the logging of rule - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - match_destination_network (
strorNone) – IP Address | CIDR | (null implies Any) - match_service (
vmware.vapi.struct.VapiStructorNone) – A NSServiceElement that specifies the matching services of source ports, destination ports, ip protocol version and number, sub protocol version and number, ICMP type and code, etc. The match_service can be one of IPProtocolNSService,L4PortSetNSService or ICMPTypeNSService. REFLEXIVE NAT does not support match_service. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement. - match_source_network (
strorNone) – IP Address | CIDR | (null implies Any) - nat_pass (
boolorNone) – Default is true. If the nat_pass is set to true, the following firewall stage will be skipped. Please note, if action is NO_NAT, then nat_pass must be set to true or omitted. - rule_priority (
longorNone) – Ascending, valid range [0-2147483647]. If multiple rules have the same priority, evaluation sequence is undefined. format: int64 - translated_network (
strorNone) – IP Address | IP Range | CIDR - translated_ports (
strorNone) – port number or port range. DNAT only
-
ACTION_DNAT= 'DNAT'¶
-
ACTION_NO_DNAT= 'NO_DNAT'¶
-
ACTION_NO_NAT= 'NO_NAT'¶
-
ACTION_NO_SNAT= 'NO_SNAT'¶
-
ACTION_REFLEXIVE= 'REFLEXIVE'¶
-
ACTION_SNAT= 'SNAT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.NatRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNatRule) – NAT rule list results
- links (
-
class
com.vmware.nsx_policy.model_client.NeighborProperties(capabilities=None, enabled_capabilities=None, ifindex=None, link_aggregation_capable=None, link_aggregation_port_id=None, link_aggregation_status=None, mac=None, mgmt_addr=None, name=None, oid=None, port_desc=None, system_desc=None, system_name=None, system_port_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNeighbor properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - capabilities (
strorNone) – Capabilities This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enabled_capabilities (
strorNone) – Enabled capabilities This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ifindex (
longorNone) – Interface index format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - link_aggregation_capable (
boolorNone) – Aggregation Capability This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - link_aggregation_port_id (
strorNone) – Aggregation port id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - link_aggregation_status (
boolorNone) – True if currently in aggregation This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac (
strorNone) – Interface MAC address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mgmt_addr (
strorNone) – Management address This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – Interface name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - oid (
strorNone) – Object identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - port_desc (
strorNone) – Port description This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_desc (
strorNone) – System description This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_name (
strorNone) – System name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_port_number (
longorNone) – System port number format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- capabilities (
-
class
com.vmware.nsx_policy.model_client.NestedExpression(expressions=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NestedExpression', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNested expressions must have three expression nodes. The first and third nodes must be condition nodes and must have the same member type. The second must be a conjunction operator with the AND operator.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - expressions (
listofvmware.vapi.struct.VapiStructorNone) – Expression When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inExpression. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inExpression. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- expressions (
-
class
com.vmware.nsx_policy.model_client.NetworkConnection(dest_element_id=None, number_of_events=None, src_element_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNetwork Connection contains the statistical information of network events.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_element_id (
strorNone) – Unique element ID of destination element to which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - number_of_events (
longorNone) – Represents the number of events/flows between the source and destination elements. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_element_id (
strorNone) – Unique element ID of source element from which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- dest_element_id (
-
class
com.vmware.nsx_policy.model_client.NetworkMigrationSpec(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NetworkMigrationSpec', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe NetworkMigrationSpec is the base class for any types of network migration specifications to be handled by transport node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Supported network migration specification types.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_HOSTPROFILENETWORKMIGRATIONSPEC= 'HostProfileNetworkMigrationSpec'¶
- links (
-
class
com.vmware.nsx_policy.model_client.NetworkMigrationSpecListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNetwork migration specification template list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – Network migration specification template results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNetworkMigrationSpec. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNetworkMigrationSpec. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.NetworkMigrationSpecTypeIdEntry(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
strorNone) –Possible values are:
the type of the NetworkMigrationSpec
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- value (
str) – the id of the NetworkMigrationSpec
-
KEY_HOSTPROFILENETWORKMIGRATIONSPEC= 'HostProfileNetworkMigrationSpec'¶
- key (
-
class
com.vmware.nsx_policy.model_client.NicInfo(gateway_address=None, ip_address=None, network_id=None, nic_metadata=None, subnet_mask=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInformation of a network interface present on the partner appliance that needs to be configured by the NSX Manager.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - gateway_address (
strorNone) – Gateway address associated with the NIC metadata. - ip_address (
strorNone) – IP address associated with the NIC metadata. - network_id (
strorNone) – Network Id associated with the NIC metadata. - nic_metadata (
NicMetadataorNone) – NIC metadata information. - subnet_mask (
strorNone) – Subnet mask associated with the NIC metadata.
- gateway_address (
-
class
com.vmware.nsx_policy.model_client.NicMetadata(interface_index=None, interface_label=None, interface_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructInformation on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - interface_index (
long) – Network Interface index. format: int64 - interface_label (
str) – Network Interface label. - interface_type (
str) –Possible values are:
NicMetadata.INTERFACE_TYPE_MANAGEMENTNicMetadata.INTERFACE_TYPE_DATA1NicMetadata.INTERFACE_TYPE_DATA2NicMetadata.INTERFACE_TYPE_HA1NicMetadata.INTERFACE_TYPE_HA2
Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2.
-
INTERFACE_TYPE_DATA1= 'DATA1'¶
-
INTERFACE_TYPE_DATA2= 'DATA2'¶
-
INTERFACE_TYPE_HA1= 'HA1'¶
-
INTERFACE_TYPE_HA2= 'HA2'¶
-
INTERFACE_TYPE_MANAGEMENT= 'MANAGEMENT'¶
- interface_index (
-
class
com.vmware.nsx_policy.model_client.NiocProfile(enabled=None, host_infra_traffic_res=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='NiocProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis profile is created for Network I/O Control(NIOC).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
boolorNone) – The enabled property specifies the status of NIOC feature. When enabled is set to true, NIOC feature is turned on and the bandwidth allocations specified for the traffic resources are enforced. When enabled is set to false, NIOC feature is turned off and no bandwidth allocation is guaranteed. By default, enabled will be set to true. - host_infra_traffic_res (
listofResourceAllocationorNone) – host_infra_traffic_res specifies bandwidth allocation for various traffic resources. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- enabled (
-
class
com.vmware.nsx_policy.model_client.Node(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='Node', tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or ‘PublicCloudGatewayNode’ - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - discovered_ip_addresses (
listofstrorNone) – Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – ID of the Node maintained on the Node and used to recognize the Node - fqdn (
strorNone) – Fully qualified domain name of the fabric node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
- links (
-
class
com.vmware.nsx_policy.model_client.NodeAggregateInfo(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, node=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAggregation of desired and runtime status of fabric node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - node (
vmware.vapi.struct.VapiStructorNone) – Node attributes When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNode. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNode. - status (
NodeStatusorNone) – Node status
- links (
-
class
com.vmware.nsx_policy.model_client.NodeAggregateInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode aggregate state list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNodeAggregateInfo) – Node Aggregate Info Results
- links (
-
class
com.vmware.nsx_policy.model_client.NodeElement(element_id=None, elements=None, resource_name=None, resource_type=None, fqdn=None, ip_addresses=None, os=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHost node element extends from Element class. NodeElement can be ‘HostNode’ or ‘EdgeNode’
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
NodeElement.RESOURCE_TYPE_VMELEMENTNodeElement.RESOURCE_TYPE_GROUPELEMENTNodeElement.RESOURCE_TYPE_PROCESSELEMENTNodeElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTNodeElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTNodeElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTNodeElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTNodeElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTNodeElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTNodeElement.RESOURCE_TYPE_HOSTNODEELEMENTNodeElement.RESOURCE_TYPE_EDGENODEELEMENTNodeElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTNodeElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element - fqdn (
strorNone) – Fully qualified domain name of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - os (
strorNone) – Operating system type and version of the node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.NodeFileSystemProperties(file_system=None, mount=None, total=None, type=None, used=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructFile system properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_system (
strorNone) – File system id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mount (
strorNone) – File system mount This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total (
longorNone) – File system size in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - type (
strorNone) – File system type This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - used (
longorNone) – Amount of file system used in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- file_system (
-
class
com.vmware.nsx_policy.model_client.NodeIdServicesMap(node_id=None, service_types=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - node_id (
str) – NodeId - service_types (
listofstr) –Possible values are:
NodeIdServicesMap.SERVICE_TYPES_MGMT_CLUSTERNodeIdServicesMap.SERVICE_TYPES_MGMT_PLANENodeIdServicesMap.SERVICE_TYPES_API
list of ServiceTypes
-
SERVICE_TYPES_API= 'API'¶
-
SERVICE_TYPES_MGMT_CLUSTER= 'MGMT_CLUSTER'¶
-
SERVICE_TYPES_MGMT_PLANE= 'MGMT_PLANE'¶
- node_id (
-
class
com.vmware.nsx_policy.model_client.NodeInterfaceAlias(broadcast_address=None, ip_address=None, ip_configuration=None, netmask=None, physical_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode network interface alias
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - broadcast_address (
strorNone) – Interface broadcast address format: ip - ip_address (
strorNone) – Interface IP address format: ip - ip_configuration (
strorNone) –Possible values are:
NodeInterfaceAlias.IP_CONFIGURATION_DHCPNodeInterfaceAlias.IP_CONFIGURATION_STATICNodeInterfaceAlias.IP_CONFIGURATION_NOT_CONFIGURED
Interface configuration - netmask (
strorNone) – Interface netmask - physical_address (
strorNone) – Interface MAC address
-
IP_CONFIGURATION_DHCP= 'dhcp'¶
-
IP_CONFIGURATION_NOT_CONFIGURED= 'not configured'¶
-
IP_CONFIGURATION_STATIC= 'static'¶
- broadcast_address (
-
class
com.vmware.nsx_policy.model_client.NodeInterfaceProperties(admin_status=None, connected_switch=None, ens_capable=None, ens_enabled=None, interface_alias=None, interface_id=None, interface_type=None, link_status=None, mtu=None, source=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode network interface properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_status (
strorNone) –Possible values are:
Interface administration status - connected_switch (
strorNone) – Connected switch - ens_capable (
boolorNone) – Interface capability for Enhanced Networking Stack - ens_enabled (
boolorNone) – Indicates whether interface is enabled for Enhanced Networking Stack - interface_alias (
listofNodeInterfaceAliasorNone) – IP Alias - interface_id (
strorNone) – Interface ID - interface_type (
strorNone) –Possible values are:
Interface Type - link_status (
strorNone) –Possible values are:
Interface administration status - mtu (
longorNone) – Interface MTU format: int64 - source (
strorNone) –Possible values are:
Source of status data
-
ADMIN_STATUS_DOWN= 'DOWN'¶
-
ADMIN_STATUS_UP= 'UP'¶
-
INTERFACE_TYPE_PHYSICAL= 'PHYSICAL'¶
-
INTERFACE_TYPE_VIRTUAL= 'VIRTUAL'¶
-
LINK_STATUS_DOWN= 'DOWN'¶
-
LINK_STATUS_UP= 'UP'¶
-
SOURCE_CACHED= 'cached'¶
-
SOURCE_REALTIME= 'realtime'¶
- admin_status (
-
class
com.vmware.nsx_policy.model_client.NodeInterfacePropertiesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode network interface properties list results
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofNodeInterfaceProperties) – Node interface property results
- links (
-
class
com.vmware.nsx_policy.model_client.NodeInterfaceStatisticsProperties(links=None, schema=None, self_=None, interface_id=None, rx_bytes=None, rx_dropped=None, rx_errors=None, rx_frame=None, rx_packets=None, source=None, tx_bytes=None, tx_carrier=None, tx_colls=None, tx_dropped=None, tx_errors=None, tx_packets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode network interface statistic properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - interface_id (
strorNone) – Interface ID - rx_bytes (
longorNone) – Number of bytes received format: int64 - rx_dropped (
longorNone) – Number of packets dropped format: int64 - rx_errors (
longorNone) – Number of receive errors format: int64 - rx_frame (
longorNone) – Number of framing errors format: int64 - rx_packets (
longorNone) – Number of packets received format: int64 - source (
strorNone) –Possible values are:
Source of status data. - tx_bytes (
longorNone) – Number of bytes transmitted format: int64 - tx_carrier (
longorNone) – Number of carrier losses detected format: int64 - tx_colls (
longorNone) – Number of collisions detected format: int64 - tx_dropped (
longorNone) – Number of packets dropped format: int64 - tx_errors (
longorNone) – Number of transmit errors format: int64 - tx_packets (
longorNone) – Number of packets transmitted format: int64
-
SOURCE_CACHED= 'cached'¶
-
SOURCE_REALTIME= 'realtime'¶
- links (
-
class
com.vmware.nsx_policy.model_client.NodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – Node list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNode. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNode.
- links (
-
class
com.vmware.nsx_policy.model_client.NodeStatus(external_id=None, host_node_deployment_status=None, inventory_sync_paused=None, inventory_sync_reenable_time=None, last_heartbeat_timestamp=None, last_sync_time=None, lcp_connectivity_status=None, lcp_connectivity_status_details=None, maintenance_mode=None, mpa_connectivity_status=None, mpa_connectivity_status_details=None, software_version=None, system_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRuntime status information of the fabric node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - external_id (
strorNone) – HostNode external id - host_node_deployment_status (
strorNone) –Possible values are:
NodeStatus.HOST_NODE_DEPLOYMENT_STATUS_NOT_PREPAREDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_INSTALL_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_INSTALL_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_INSTALL_SUCCESSFULNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_SUCCESSFULNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_PENDING_UPGRADENodeStatus.HOST_NODE_DEPLOYMENT_STATUS_NOT_AVAILABLENodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_QUEUEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_PENDINGNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_NODE_NOT_READYNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_NODE_READYNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_IN_PROGRESSNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_FAILEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_SUCCESSFULNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_EDGE_CONFIG_ERRORNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_RESTARTEDNodeStatus.HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_FAILED
This enum specifies the current nsx install state for host node or current deployment and ready state for edge node. The ready status ‘NODE_READY’ indicates whether edge node is ready to become a transport node. The status ‘EDGE_CONFIG_ERROR’ indicates that edge hardware or underlying host is not supported. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- inventory_sync_paused (
boolorNone) – Is true if inventory sync is paused else false This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - inventory_sync_reenable_time (
longorNone) – Inventory sync auto re-enable target time, in epoch milis format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_heartbeat_timestamp (
longorNone) – Timestamp of the last heartbeat status change, in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_sync_time (
longorNone) – Timestamp of the last successful update of Inventory, in epoch milliseconds. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lcp_connectivity_status (
strorNone) –Possible values are:
NodeStatus.LCP_CONNECTIVITY_STATUS_UPNodeStatus.LCP_CONNECTIVITY_STATUS_DOWNNodeStatus.LCP_CONNECTIVITY_STATUS_DEGRADEDNodeStatus.LCP_CONNECTIVITY_STATUS_UNKNOWN
Indicates the fabric node’s LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- lcp_connectivity_status_details (
listofControlConnStatusorNone) – Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - maintenance_mode (
strorNone) –Possible values are:
NodeStatus.MAINTENANCE_MODE_OFFNodeStatus.MAINTENANCE_MODE_ENTERINGNodeStatus.MAINTENANCE_MODE_ONNodeStatus.MAINTENANCE_MODE_EXITING
Indicates the fabric node’s status of maintenance mode, OFF, ENTERING, ON, EXITING. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- mpa_connectivity_status (
strorNone) –Possible values are:
NodeStatus.MPA_CONNECTIVITY_STATUS_UPNodeStatus.MPA_CONNECTIVITY_STATUS_DOWNNodeStatus.MPA_CONNECTIVITY_STATUS_UNKNOWN
Indicates the fabric node’s MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- mpa_connectivity_status_details (
strorNone) – Details, if any, about the current MP<->MPA channel connectivity status of the fabric node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - software_version (
strorNone) – Software version of the fabric node. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_status (
NodeStatusPropertiesorNone) – Node status properties
-
HOST_NODE_DEPLOYMENT_STATUS_EDGE_CONFIG_ERROR= 'EDGE_CONFIG_ERROR'¶
-
HOST_NODE_DEPLOYMENT_STATUS_INSTALL_FAILED= 'INSTALL_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_INSTALL_IN_PROGRESS= 'INSTALL_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_INSTALL_SUCCESSFUL= 'INSTALL_SUCCESSFUL'¶
-
HOST_NODE_DEPLOYMENT_STATUS_NODE_NOT_READY= 'NODE_NOT_READY'¶
-
HOST_NODE_DEPLOYMENT_STATUS_NODE_READY= 'NODE_READY'¶
-
HOST_NODE_DEPLOYMENT_STATUS_NOT_AVAILABLE= 'NOT_AVAILABLE'¶
-
HOST_NODE_DEPLOYMENT_STATUS_NOT_PREPARED= 'NOT_PREPARED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_PENDING_UPGRADE= 'PENDING_UPGRADE'¶
-
HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_FAILED= 'REGISTRATION_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_REGISTRATION_PENDING= 'REGISTRATION_PENDING'¶
-
HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_FAILED= 'UNINSTALL_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_IN_PROGRESS= 'UNINSTALL_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_UNINSTALL_SUCCESSFUL= 'UNINSTALL_SUCCESSFUL'¶
-
HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_FAILED= 'UPGRADE_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS= 'UPGRADE_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_FAILED= 'VM_DEPLOYMENT_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_IN_PROGRESS= 'VM_DEPLOYMENT_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_QUEUED= 'VM_DEPLOYMENT_QUEUED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_DEPLOYMENT_RESTARTED= 'VM_DEPLOYMENT_RESTARTED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_FAILED= 'VM_POWER_OFF_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_OFF_IN_PROGRESS= 'VM_POWER_OFF_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_FAILED= 'VM_POWER_ON_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_POWER_ON_IN_PROGRESS= 'VM_POWER_ON_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_FAILED= 'VM_UNDEPLOY_FAILED'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_IN_PROGRESS= 'VM_UNDEPLOY_IN_PROGRESS'¶
-
HOST_NODE_DEPLOYMENT_STATUS_VM_UNDEPLOY_SUCCESSFUL= 'VM_UNDEPLOY_SUCCESSFUL'¶
-
LCP_CONNECTIVITY_STATUS_DEGRADED= 'DEGRADED'¶
-
LCP_CONNECTIVITY_STATUS_DOWN= 'DOWN'¶
-
LCP_CONNECTIVITY_STATUS_UNKNOWN= 'UNKNOWN'¶
-
LCP_CONNECTIVITY_STATUS_UP= 'UP'¶
-
MAINTENANCE_MODE_ENTERING= 'ENTERING'¶
-
MAINTENANCE_MODE_EXITING= 'EXITING'¶
-
MAINTENANCE_MODE_OFF= 'OFF'¶
-
MAINTENANCE_MODE_ON= 'ON'¶
-
MPA_CONNECTIVITY_STATUS_DOWN= 'DOWN'¶
-
MPA_CONNECTIVITY_STATUS_UNKNOWN= 'UNKNOWN'¶
-
MPA_CONNECTIVITY_STATUS_UP= 'UP'¶
- external_id (
-
class
com.vmware.nsx_policy.model_client.NodeStatusProperties(links=None, schema=None, self_=None, cpu_cores=None, file_systems=None, load_average=None, mem_cache=None, mem_total=None, mem_used=None, source=None, swap_total=None, swap_used=None, system_time=None, uptime=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNode status properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cpu_cores (
longorNone) – Number of CPU cores on the system format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - file_systems (
listofNodeFileSystemPropertiesorNone) – File systems configured on the system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - load_average (
listoffloatorNone) – One, five, and fifteen minute load averages for the system This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mem_cache (
longorNone) – Amount of RAM on the system that can be flushed out to disk, in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mem_total (
longorNone) – Amount of RAM allocated to the system, in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mem_used (
longorNone) – Amount of RAM in use on the system, in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - source (
strorNone) –Possible values are:
Source of status data.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- swap_total (
longorNone) – Amount of disk available for swap, in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - swap_used (
longorNone) – Amount of swap disk in use, in kilobytes format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_time (
longorNone) – Current time expressed in milliseconds since epoch format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - uptime (
longorNone) – Milliseconds since system start format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
SOURCE_CACHED= 'cached'¶
-
SOURCE_REALTIME= 'realtime'¶
- links (
-
class
com.vmware.nsx_policy.model_client.NodeUserSettings(audit_password=None, audit_username=None, cli_password=None, cli_username=None, root_password=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - audit_password (
strorNone) – Password for the node audit user. For deployment, this property is required. After deployment, this property is ignored, and the node cli must be used to change the password. The password specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (except quotes). - audit_username (
strorNone) – The default username is "audit". To configure username, you must provide this property together with audit_password. - cli_password (
strorNone) – Password for the node cli user. For deployment, this property is required. After deployment, this property is ignored, and the node cli must be used to change the password. The password specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (except quotes). - cli_username (
strorNone) – To configure username, you must provide this property together with cli_password. - root_password (
strorNone) – Password for the node root user. For deployment, this property is required. After deployment, this property is ignored, and the node cli must be used to change the password. The password specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one special character (except quotes).
- audit_password (
-
class
com.vmware.nsx_policy.model_client.NormalizedResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of normalized resources
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofResourceReference) – Normalized resource list results
- links (
-
class
com.vmware.nsx_policy.model_client.NsxRole(permissions=None, role=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRole
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - permissions (
listofstrorNone) –Possible values are:
NsxRole.PERMISSIONS_READ_APINsxRole.PERMISSIONS_READ_WRITE_APINsxRole.PERMISSIONS_CRUDNsxRole.PERMISSIONS_READNsxRole.PERMISSIONS_EXECUTENsxRole.PERMISSIONS_NONE
Please use the /user-info/permissions api to get the permission that the user has on each feature.
- role (
str) –Possible values are:
NsxRole.ROLE_READ_ONLY_API_USERSNsxRole.ROLE_READ_WRITE_API_USERSNsxRole.ROLE_ENTERPRISE_ADMINNsxRole.ROLE_AUDITORNsxRole.ROLE_NETWORK_ENGINEERNsxRole.ROLE_NETWORK_OPNsxRole.ROLE_SECURITY_ENGINEERNsxRole.ROLE_SECURITY_OPNsxRole.ROLE_LB_ADMINNsxRole.ROLE_LB_AUDITORNsxRole.ROLE_CLOUD_SERVICE_ADMINNsxRole.ROLE_CLOUD_SERVICE_AUDITORNsxRole.ROLE_SITE_RELIABILITY_ENGINEERNsxRole.ROLE_SITE_RELIABILITY_AUDITORNsxRole.ROLE_CLOUD_ADMINNsxRole.ROLE_CLOUD_AUDITOR
Role name
-
PERMISSIONS_CRUD= 'crud'¶
-
PERMISSIONS_EXECUTE= 'execute'¶
-
PERMISSIONS_NONE= 'none'¶
-
PERMISSIONS_READ= 'read'¶
-
PERMISSIONS_READ_API= 'read-api'¶
-
PERMISSIONS_READ_WRITE_API= 'read-write-api'¶
-
ROLE_AUDITOR= 'auditor'¶
-
ROLE_CLOUD_ADMIN= 'cloud_admin'¶
-
ROLE_CLOUD_AUDITOR= 'cloud_auditor'¶
-
ROLE_CLOUD_SERVICE_ADMIN= 'cloud_service_admin'¶
-
ROLE_CLOUD_SERVICE_AUDITOR= 'cloud_service_auditor'¶
-
ROLE_ENTERPRISE_ADMIN= 'enterprise_admin'¶
-
ROLE_LB_ADMIN= 'lb_admin'¶
-
ROLE_LB_AUDITOR= 'lb_auditor'¶
-
ROLE_NETWORK_ENGINEER= 'network_engineer'¶
-
ROLE_NETWORK_OP= 'network_op'¶
-
ROLE_READ_ONLY_API_USERS= 'read_only_api_users'¶
-
ROLE_READ_WRITE_API_USERS= 'read_write_api_users'¶
-
ROLE_SECURITY_ENGINEER= 'security_engineer'¶
-
ROLE_SECURITY_OP= 'security_op'¶
-
ROLE_SITE_RELIABILITY_AUDITOR= 'site_reliability_auditor'¶
-
ROLE_SITE_RELIABILITY_ENGINEER= 'site_reliability_engineer'¶
- permissions (
-
class
com.vmware.nsx_policy.model_client.ObjectRolePermissionGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, operation=None, path_prefix=None, role_name=None, rule_disabled=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRBAC Objects qualifier
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - operation (
strorNone) –Possible values are:
ObjectRolePermissionGroup.OPERATION_CRUDObjectRolePermissionGroup.OPERATION_READObjectRolePermissionGroup.OPERATION_EXECUTEObjectRolePermissionGroup.OPERATION_NONE
Allowed operation - path_prefix (
str) – Path prefix - role_name (
str) – Role name - rule_disabled (
boolorNone) – Is rule disabled or not
-
OPERATION_CRUD= 'crud'¶
-
OPERATION_EXECUTE= 'execute'¶
-
OPERATION_NONE= 'none'¶
-
OPERATION_READ= 'read'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ObjectRolePermissionGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of RBAC Objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofObjectRolePermissionGroup) – ObjectRolePermissionGroup list results
- links (
-
class
com.vmware.nsx_policy.model_client.OwnerResourceLink(action=None, href=None, rel=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe server will populate this field when returing the resource. Ignored on PUT and POST.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
strorNone) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - href (
strorNone) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rel (
strorNone) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- action (
-
class
com.vmware.nsx_policy.model_client.PBRRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, disabled=None, logged=None, notes=None, rule_tag=None, services=None, sources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - action (
str) –Possible values are:
PBRRule.ACTION_UNDERLAY_NATPBRRule.ACTION_OVERLAY_NATPBRRule.ACTION_UNDERLAYPBRRule.ACTION_OVERLAY
Action enforced on the packets which matches the PBR rule. - applied_tos (
listofResourceReferenceorNone) – List of object where rule will be enforced. field overrides this one. Null will be treated as any. - destinations (
listofResourceReferenceorNone) – List of the destinations. Null will be treated as any. - disabled (
boolorNone) – Flag to disable rule. Disabled will only be persisted but never provisioned/realized. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - notes (
strorNone) – User notes specific to the rule. - rule_tag (
strorNone) – User level field which will be printed in CLI and packet logs. - services (
listofPBRServiceorNone) – List of the services. Null will be treated as any. - sources (
listofResourceReferenceorNone) – List of sources. Null will be treated as any.
-
ACTION_OVERLAY= 'ROUTE_TO_OVERLAY'¶
-
ACTION_OVERLAY_NAT= 'ROUTE_TO_OVERLAY_NAT'¶
-
ACTION_UNDERLAY= 'ROUTE_TO_UNDERLAY'¶
-
ACTION_UNDERLAY_NAT= 'ROUTE_TO_UNDERLAY_NAT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PBRRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPBRRuleorNone) – PBR rule list result with pagination support. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PBRSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PBRSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPBRSectionorNone) – List of the PBR sections. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PBRSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, rule_count=None, rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rules (
listofPBRRule) – List of PBR rules in the section.
- links (
-
class
com.vmware.nsx_policy.model_client.PBRService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructType to define services associated with every rule
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - service (
vmware.vapi.struct.VapiStructorNone) – Distributed Service API accepts raw protocol and ports as part of NS service element in Distributed Service Rule that describes traffic corresponding to an NSService. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.PackageStore(bulletin_ids=None, package_url=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains package information
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - bulletin_ids (
listofstr) – List of bulletin ids - package_url (
str) – url of the package
- bulletin_ids (
-
class
com.vmware.nsx_policy.model_client.PacketAddressClassifier(ip_address=None, mac_address=None, vlan=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA packet is classified to have an address binding, if its address configuration matches with all user specified properties.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_address (
strorNone) – A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y format: address-or-block-or-range - mac_address (
strorNone) – A single MAC address - vlan (
longorNone) – Virtual Local Area Network Identifier format: int64
- ip_address (
-
class
com.vmware.nsx_policy.model_client.PacketCaptureOption(name=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe option is used to filter data on given node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - name (
strorNone) –Possible values are:
PacketCaptureOption.NAME_ETHTYPEPacketCaptureOption.NAME_MACPacketCaptureOption.NAME_SRCMACPacketCaptureOption.NAME_DSTMACPacketCaptureOption.NAME_VLANPacketCaptureOption.NAME_IPPacketCaptureOption.NAME_SRCIPPacketCaptureOption.NAME_DSTIPPacketCaptureOption.NAME_IPPROTOPacketCaptureOption.NAME_PORTPacketCaptureOption.NAME_SRCPORTPacketCaptureOption.NAME_DSTPORTPacketCaptureOption.NAME_VNI
The avaiable option names in the enum can be used to filter the capture data.
- value (
strorNone) – Define the capture value according to the given capture option.
-
NAME_DSTIP= 'DSTIP'¶
-
NAME_DSTMAC= 'DSTMAC'¶
-
NAME_DSTPORT= 'DSTPORT'¶
-
NAME_ETHTYPE= 'ETHTYPE'¶
-
NAME_IP= 'IP'¶
-
NAME_IPPROTO= 'IPPROTO'¶
-
NAME_MAC= 'MAC'¶
-
NAME_PORT= 'PORT'¶
-
NAME_SRCIP= 'SRCIP'¶
-
NAME_SRCMAC= 'SRCMAC'¶
-
NAME_SRCPORT= 'SRCPORT'¶
-
NAME_VLAN= 'VLAN'¶
-
NAME_VNI= 'VNI'¶
- name (
-
class
com.vmware.nsx_policy.model_client.PacketCaptureOptionList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, values=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of packet capture options to filter data in capture process.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - values (
listofPacketCaptureOptionorNone) – Packet capture option collection
- links (
-
class
com.vmware.nsx_policy.model_client.PacketCaptureRequest(capamount=None, capduration=None, capfilesize=None, capmode=None, cappoint=None, caprate=None, capsource=None, capvalue=None, direction=None, filtertype=None, node=None, options=None, streamaddress=None, streamport=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis type is used to create packet request on give node. Need to specify related parameters according to the capture point.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - capamount (
longorNone) – Define the packet capture amount size. format: int32 - capduration (
longorNone) – Define the packet capture duration time. After the capture duration time, the capture process will stop working. format: int32 - capfilesize (
longorNone) – Define the packet capture file size limit. format: int32 - capmode (
strorNone) –Possible values are:
Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.
- cappoint (
str) –Possible values are:
PacketCaptureRequest.CAPPOINT_VNICPacketCaptureRequest.CAPPOINT_VMKNICPacketCaptureRequest.CAPPOINT_VMNICPacketCaptureRequest.CAPPOINT_VDRPORTPacketCaptureRequest.CAPPOINT_DVFILTERPacketCaptureRequest.CAPPOINT_LOGICALPORTPacketCaptureRequest.CAPPOINT_VIF
Define the point to capture data. - caprate (
longorNone) – Define the rate of packet capture process. format: int32 - capsource (
str) –Possible values are:
This type is used to differenite the incoming request from CLI/UI. - capvalue (
strorNone) – Define the capture value of given capture point. - direction (
strorNone) –Possible values are:
PacketCaptureRequest.DIRECTION_INPUTPacketCaptureRequest.DIRECTION_OUTPUTPacketCaptureRequest.DIRECTION_DUAL
Define the capture direction. Support three types INPUT/OUTPUT/DUAL.
- filtertype (
strorNone) –Possible values are:
Define the capture filter type. Support PRE/POST mode. - node (
strorNone) – Define the transport node to capture data. - options (
PacketCaptureOptionListorNone) – Define the packet capture additional options to filter the capture data. - streamaddress (
strorNone) – Set the stream address to receive the capture packet. - streamport (
longorNone) – Set the stream port to receive the capture packet. format: int32
-
CAPMODE_STANDALONE= 'STANDALONE'¶
-
CAPMODE_STREAM= 'STREAM'¶
-
CAPPOINT_DVFILTER= 'DVFILTER'¶
-
CAPPOINT_LOGICALPORT= 'LOGICALPORT'¶
-
CAPPOINT_VDRPORT= 'VDRPORT'¶
-
CAPPOINT_VIF= 'VIF'¶
-
CAPPOINT_VMKNIC= 'VMKNIC'¶
-
CAPPOINT_VMNIC= 'VMNIC'¶
-
CAPPOINT_VNIC= 'VNIC'¶
-
CAPSOURCE_CLI= 'CLI'¶
-
CAPSOURCE_UI= 'UI'¶
-
DIRECTION_DUAL= 'DUAL'¶
-
DIRECTION_INPUT= 'INPUT'¶
-
DIRECTION_OUTPUT= 'OUTPUT'¶
-
FILTERTYPE_POST= 'POST'¶
-
FILTERTYPE_PRE= 'PRE'¶
- capamount (
-
class
com.vmware.nsx_policy.model_client.PacketCaptureSession(endtime=None, errormsg=None, filelocation=None, filesize=None, request=None, sessionid=None, sessionname=None, sessionstatus=None, starttime=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPacket capture response information
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - endtime (
longorNone) – Timestamp when session was stopped in epoch millisecond format: int64 - errormsg (
strorNone) – Error messasge in capture - filelocation (
strorNone) – Packet capture file location - filesize (
longorNone) – Packet capture file Size in bytes format: int32 - request (
PacketCaptureRequest) – Packet capture request - sessionid (
str) – Packet capture session id - sessionname (
strorNone) – Packet capture session name - sessionstatus (
str) –Possible values are:
PacketCaptureSession.SESSIONSTATUS_CREATEDPacketCaptureSession.SESSIONSTATUS_STARTEDPacketCaptureSession.SESSIONSTATUS_STOPPEDPacketCaptureSession.SESSIONSTATUS_FINISHEDPacketCaptureSession.SESSIONSTATUS_ERROR
Packet capture session status - starttime (
longorNone) – Timestamp when session was created in epoch millisecond format: int64
-
SESSIONSTATUS_CREATED= 'CREATED'¶
-
SESSIONSTATUS_ERROR= 'ERROR'¶
-
SESSIONSTATUS_FINISHED= 'FINISHED'¶
-
SESSIONSTATUS_STARTED= 'STARTED'¶
-
SESSIONSTATUS_STOPPED= 'STOPPED'¶
- endtime (
-
class
com.vmware.nsx_policy.model_client.PacketCaptureSessionList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
long) – Total capture session count format: int64 - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPacketCaptureSessionorNone) – Packet capture list for all sessoins
- links (
-
class
com.vmware.nsx_policy.model_client.PartnerServiceEULAStatus(accepted=None, eula_link=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEULA status for partner service per user
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - accepted (
bool) – States if EULA is accepted or not - eula_link (
strorNone) – Contains link to end user’s terms and conditions
- accepted (
-
class
com.vmware.nsx_policy.model_client.PerStepRestoreStatus(description=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRestore step status
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - description (
strorNone) – A description of the restore status This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - value (
strorNone) –Possible values are:
PerStepRestoreStatus.VALUE_INITIALPerStepRestoreStatus.VALUE_RUNNINGPerStepRestoreStatus.VALUE_SUSPENDED_BY_USERPerStepRestoreStatus.VALUE_SUSPENDED_FOR_USER_ACTIONPerStepRestoreStatus.VALUE_FAILEDPerStepRestoreStatus.VALUE_SUCCESS
Per step restore status valueThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
VALUE_FAILED= 'FAILED'¶
-
VALUE_INITIAL= 'INITIAL'¶
-
VALUE_RUNNING= 'RUNNING'¶
-
VALUE_SUCCESS= 'SUCCESS'¶
-
VALUE_SUSPENDED_BY_USER= 'SUSPENDED_BY_USER'¶
-
VALUE_SUSPENDED_FOR_USER_ACTION= 'SUSPENDED_FOR_USER_ACTION'¶
- description (
-
class
com.vmware.nsx_policy.model_client.Pnic(device_name=None, uplink_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPhysical NIC specification
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - device_name (
str) – device name or key - uplink_name (
str) – Uplink name for this Pnic. This name will be used to reference this Pnic in other configurations.
- device_name (
-
class
com.vmware.nsx_policy.model_client.PnicBondStatus(name=None, status=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructpNIC/bond statuses
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - name (
strorNone) – Name of the pNIC/bond - status (
strorNone) –Possible values are:
PnicBondStatus.STATUS_UNKNOWNPnicBondStatus.STATUS_UPPnicBondStatus.STATUS_DOWNPnicBondStatus.STATUS_DEGRADED
Status of pNIC/bond - type (
strorNone) –Possible values are:
type, whether the object is a pNIC or a bond
-
STATUS_DEGRADED= 'DEGRADED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
-
TYPE_BOND= 'BOND'¶
-
TYPE_PNIC= 'PNIC'¶
-
TYPE_UNKNOWN_TYPE= 'UNKNOWN_TYPE'¶
- name (
-
class
com.vmware.nsx_policy.model_client.PnicBondStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThis object contains reference to list of pNIC/bond statuses
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPnicBondStatusorNone) – List of pNIC statuses belonging to the transport node
- links (
-
class
com.vmware.nsx_policy.model_client.PnicMirrorDestination(dest_pnics=None, node_id=None, resource_type='PnicMirrorDestination')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_pnics (
listofstr) – Physical NIC device names to which to send the mirrored packets - node_id (
str) – Transport node to which to send the mirrored packets - resource_type (
str) –Possible values are:
MirrorDestination.RESOURCE_TYPE_LOGICALPORTMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_PNICMIRRORDESTINATIONMirrorDestination.RESOURCE_TYPE_IPMIRRORDESTINATION
Resource types of mirror destination
- dest_pnics (
-
class
com.vmware.nsx_policy.model_client.PnicMirrorSource(encapsulated=None, node_id=None, source_pnics=None, resource_type='PnicMirrorSource')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - encapsulated (
bool) – Whether to filter encapsulated packet. - node_id (
str) – Transport node identifier for the pnic located. - source_pnics (
listofstr) – Source physical NIC device names - resource_type (
str) –Possible values are:
MirrorSource.RESOURCE_TYPE_LOGICALPORTMIRRORSOURCEMirrorSource.RESOURCE_TYPE_PNICMIRRORSOURCEMirrorSource.RESOURCE_TYPE_VLANMIRRORSOURCEMirrorSource.RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE
Resource types of mirror source
- encapsulated (
-
class
com.vmware.nsx_policy.model_client.PolicyAlarmResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, error_details=None, message=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAlarm base class of realized policy object
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – error id for the alarm - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – path of the alarm object - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - error_details (
PolicyApiErrororNone) – Detailed information about errors from an API call made to the enforcement point, if any. - message (
strorNone) – error message to describe the issue
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None, related_errors=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDetailed information about errors from API call to an enforcement point
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
strorNone) – Further details about the error - error_code (
longorNone) – A numeric error code format: int64 - error_data (
vmware.vapi.struct.VapiStructorNone) – Additional data about the error - error_message (
strorNone) – A description of the error - module_name (
strorNone) – The module name where the error occurred - related_errors (
listofPolicyApiErrororNone) – Other errors related to this error
- details (
-
class
com.vmware.nsx_policy.model_client.PolicyAssociationsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection for Associations
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyResource) – Associations list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyBasedIPSecVPNSession(policy_rules=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PolicyBasedIPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - policy_rules (
listofIPSecVPNPolicyRule) – Policy rules - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
IPSecVPNSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSIONIPSecVPNSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Enable/Disable IPSec VPN session. - ipsec_vpn_service_id (
strorNone) – Identifier of VPN Service linked with local endpoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_endpoint_id (
str) – Local endpoint identifier. - peer_endpoint_id (
str) – Peer endpoint identifier.
- policy_rules (
-
class
com.vmware.nsx_policy.model_client.PolicyBasedL3VpnSession(rules=None, resource_type='PolicyBasedL3VpnSession')¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Policy-based L3Vpn session is a configuration in which a specific vpn tunnel is referenced in a policy whose action is set as tunnel.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - rules (
listofL3VpnRuleorNone) – L3Vpn rules that are specific to the L3Vpn. Only L3Vpn rules with PROTECT action are supported. - resource_type (
str) –Possible values are:
L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSIONL3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION
- A Policy Based L3Vpn is a configuration in which protect rules to
match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.
- rules (
-
class
com.vmware.nsx_policy.model_client.PolicyConfigResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an object on the desired state
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyDnsForwarder(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, conditional_forwarder_zone_paths=None, default_forwarder_zone_path=None, listener_ip=None, log_level=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed to configure DNS Forwarder
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - conditional_forwarder_zone_paths (
listofstrorNone) – Max of 5 DNS servers can be configured - default_forwarder_zone_path (
str) – This is the zone to which DNS requests are forwarded by default - listener_ip (
str) – This is the IP on which the DNS Forwarder listens. format: ipv4 - log_level (
strorNone) –Possible values are:
PolicyDnsForwarder.LOG_LEVEL_DISABLEDPolicyDnsForwarder.LOG_LEVEL_TRACEPolicyDnsForwarder.LOG_LEVEL_DEBUGPolicyDnsForwarder.LOG_LEVEL_INFOPolicyDnsForwarder.LOG_LEVEL_WARNINGPolicyDnsForwarder.LOG_LEVEL_ERRORPolicyDnsForwarder.LOG_LEVEL_FATAL
Set log_level to DISABLED will stop dumping fowarder log.
-
LOG_LEVEL_DEBUG= 'DEBUG'¶
-
LOG_LEVEL_DISABLED= 'DISABLED'¶
-
LOG_LEVEL_ERROR= 'ERROR'¶
-
LOG_LEVEL_FATAL= 'FATAL'¶
-
LOG_LEVEL_INFO= 'INFO'¶
-
LOG_LEVEL_TRACE= 'TRACE'¶
-
LOG_LEVEL_WARNING= 'WARNING'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyDnsForwarderListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Dns Forwarders
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyDnsForwarder) – DNS Forwarder list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyDnsForwarderZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, dns_domain_names=None, upstream_servers=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed to configure zones on DNS Forwarder
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dns_domain_names (
listofstrorNone) – List of domain names on which conditional forwarding is based. This field is required if the DNS Zone is being used for a conditional forwarder. This field will also be used for conditional reverse lookup. Example 1, if for one of the zones, one of the entries in the fqdn is example.com, all the DNS requests under the domain example.com will be served by the corresponding upstream DNS server. Example 2, if for one of the zones, one of the entries in the fqdn list is "13.12.30.in-addr.arpa", reverse lookup for 30.12.13.0/24 will go to the corresponding DNS server. - upstream_servers (
listofstr) – Max of 3 DNS servers can be configured format: ipv4
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyDnsForwarderZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of DNS Forwarder Zones
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyDnsForwarderZone) – Dns Forwarder Zone list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyGroupIPMembersListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaginated collection of IP members belonging to a Group.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofstr) – Paged Collection of IP addresses that belong to the given Group format: address-or-block-or-range
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyIPAddressInfo(address_value=None, display_name=None, next_hop=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed to specify the display name and value of the IPv4Address.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - address_value (
str) – Value of the IPv4Address. format: ipv4 - display_name (
strorNone) – Display name used to help identify the IPv4Address. - next_hop (
strorNone) – Next hop used in auto-plumbing of static route. If a value is not provided, static route will not be auto-plumbed. format: ipv4
- address_value (
-
class
com.vmware.nsx_policy.model_client.PolicyLabel(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, refs=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructLabel to reference group of policy entities of same type.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - refs (
listofstrorNone) – Policy entity paths referred by the label instance - type (
str) – Policy intent entity type from PolicyResourceType
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyLabelListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Domains
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyLabel) – Policy label list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyNat(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, nat_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents NAT section. This object is created by default when corresponding tier-1 is created. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - nat_type (
strorNone) –Possible values are:
Represents a NAT section under tier-1.
-
NAT_TYPE_DEFAULT= 'DEFAULT'¶
-
NAT_TYPE_INTERNAL= 'INTERNAL'¶
-
NAT_TYPE_USER= 'USER'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyNatRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_network=None, scope=None, sequence_number=None, service=None, source_network=None, translated_network=None, translated_ports=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a NAT rule between source and destination at T0/T1 router.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - action (
str) –Possible values are:
PolicyNatRule.ACTION_SNATPolicyNatRule.ACTION_DNATPolicyNatRule.ACTION_REFLEXIVEPolicyNatRule.ACTION_NO_SNATPolicyNatRule.ACTION_NO_DNAT
Source NAT(SNAT) - translates a source IP address in an outbound packet so that the packet appears to originate from a different network. SNAT is only supported when the logical router is running in active-standby mode. Destination NAT(DNAT) - translates the destination IP address of inbound packets so that packets are delivered to a target address into another network. DNAT is only supported when the logical router is running in active-standby mode. Reflexive NAT(REFLEXIVE) - IP-Range and CIDR are supported to define the "n". The number of original networks should be exactly the same as that of translated networks. The address translation is deterministic. Reflexive is supported on both Active/Standby and Active/Active LR. NO_SNAT and NO_DNAT - These do not have support for translated_fields, only source_network and destination_network fields are supported.
- destination_network (
strorNone) – IP Address | Comma separeted list of IP addresses | CIDR. For DNAT and NO_DNAT rules, this is a mandatory field, and represents the destination network for the incoming packets. For other type of rules, optionally it can contain destination network of outgoing packets. NULL value for this field represents ANY network. format: list-of-address-or-block-or-range - scope (
listofstrorNone) – Represents the array of policy paths of labels of type ProviderInterface on which the NAT rule should get enforced. The tier-0 interfaces must belong to the same tier-0 router for which the NAT Rule is created. - sequence_number (
longorNone) – The sequence_number decides the rule_priority of a NAT rule. Sequence_number and rule_priority have 1:1 mapping.For each NAT section, there will be reserved rule_priority numbers.The valid range of rule_priority number is from 0 to 2147483647(MAX_INT). 1. INTERNAL section rule_priority reserved from 0 - 1023 (1024 rules) valid sequence_number range 0 - 1023 2. USER section rule_priority reserved from 1024 - 2147482623 (2147481600 rules) valid sequence_number range 0 - 2147481599 3. DEFAULT section rule_priority reserved from 2147482624 - 2147483647 (1024 rules) valid sequence_number range 0 - 1023 format: int32 - service (
strorNone) – It represents the path of Service on which the NAT rule will be applied. If not provided or if it is blank then Policy manager will consider it as ANY. - source_network (
strorNone) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, NO_SNAT and REFLEXIVE rules, this is a mandatory field and represents the source network of the packets leaving the network. For DNAT and NO_DNAT rules, optionally it can contain source network of incoming packets. NULL value for this field represents ANY network. format: list-of-address-or-block-or-range - translated_network (
strorNone) – IP Address | Comma separeted list of IP addresses | CIDR. For SNAT, DNAT and REFLEXIVE rules, this ia a mandatory field, which represents the translated network address. For NO_SNAT and NO_DNAT this should be empty. format: list-of-address-or-block-or-range - translated_ports (
strorNone) – Port number or port range format: port-or-range
-
ACTION_DNAT= 'DNAT'¶
-
ACTION_NO_DNAT= 'NO_DNAT'¶
-
ACTION_NO_SNAT= 'NO_SNAT'¶
-
ACTION_REFLEXIVE= 'REFLEXIVE'¶
-
ACTION_SNAT= 'SNAT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyNatRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of NAT Rules
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyNatRule) – NAT Rules list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyRealizedResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base class for all the realized policy objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
PolicyRealizedResource.STATE_UNAVAILABLEPolicyRealizedResource.STATE_UNREALIZEDPolicyRealizedResource.STATE_REALIZEDPolicyRealizedResource.STATE_ERROR
Realization state of this object
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base class for all the policy objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None, path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy resource reference
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.PolicyResourceReferenceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of PolicyResourceReference
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyResourceReference) – Policy resource references list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyRoot(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the root of the policy tree
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, deployment_mode=None, partner_service_name=None, transport_type=None, attributes=None, compute_id=None, context_id=None, deployment_spec_name=None, deployment_template_name=None, failure_policy=None, primary_interface_mgmt_ip=None, primary_interface_network=None, secondary_interface_mgmt_ip=None, secondary_interface_network=None, storage_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents an instance of partner Service and its configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - deployment_mode (
strorNone) –Possible values are:
PolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONEPolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY
Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
- partner_service_name (
str) – Unique name of Partner Service to be consumed in redirection - transport_type (
strorNone) –Possible values are:
Transport to be used while deploying Service-VM. - attributes (
listofAttribute) – List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance. - compute_id (
str) – Id of the compute(ResourcePool) to which this service needs to be deployed. - context_id (
strorNone) – UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed. - deployment_spec_name (
str) – Form factor for the deployment of partner service. - deployment_template_name (
str) – Template for the deployment of partnet service. - failure_policy (
strorNone) –Possible values are:
Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.
- primary_interface_mgmt_ip (
str) – Management IP Address of primary interface of the Service format: address-or-block-or-range - primary_interface_network (
str) – Path of the Network to which primary interface of the Service VM needs to be connected - secondary_interface_mgmt_ip (
str) – Management IP Address of secondary interface of the Service format: address-or-block-or-range - secondary_interface_network (
str) – Path of Network to which secondary interface of the Service VM needs to be connected - storage_id (
str) – Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.
-
DEPLOYMENT_MODE_ACTIVE_STANDBY= 'ACTIVE_STANDBY'¶
-
DEPLOYMENT_MODE_STAND_ALONE= 'STAND_ALONE'¶
-
FAILURE_POLICY_ALLOW= 'ALLOW'¶
-
FAILURE_POLICY_BLOCK= 'BLOCK'¶
-
TRANSPORT_TYPE_L2_BRIDGE= 'L2_BRIDGE'¶
-
TRANSPORT_TYPE_L3_ROUTED= 'L3_ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of only SI objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyServiceInstance) – Service instance list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyTemplate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, template_body=None, template_placeholders=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy Template
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - template_body (
vmware.vapi.struct.VapiStruct) – Body of an instance of Infra - template_placeholders (
listofPolicyTemplatePlaceholder) – Template placeholders
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyTemplateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Policy Templates
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPolicyTemplate) – Policy Template list results
- links (
-
class
com.vmware.nsx_policy.model_client.PolicyTemplateParameter(parameter_id=None, parameter_value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy template parameter
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - parameter_id (
str) – Parameter id - parameter_value (
str) – Parameter value
- parameter_id (
-
class
com.vmware.nsx_policy.model_client.PolicyTemplateParameters(placeholders=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy template parameters
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: placeholders ( listofPolicyTemplateParameter) – List of Policy template parameter
-
class
com.vmware.nsx_policy.model_client.PolicyTemplatePlaceholder(placeholder_id=None, placeholder_message=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPolicy template placeholdder
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - placeholder_id (
str) – Placeholder id - placeholder_message (
str) – Placeholder message
- placeholder_id (
-
class
com.vmware.nsx_policy.model_client.PoolMember(admin_state=None, backup_member=None, display_name=None, ip_address=None, max_concurrent_connections=None, port=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_state (
strorNone) –Possible values are:
PoolMember.ADMIN_STATE_ENABLEDPoolMember.ADMIN_STATE_DISABLEDPoolMember.ADMIN_STATE_GRACEFUL_DISABLED
member admin state - backup_member (
boolorNone) – Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s). - display_name (
strorNone) – pool member name - ip_address (
str) – pool member IP address format: ip - max_concurrent_connections (
longorNone) – To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited. format: int64 - port (
strorNone) – If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case. format: port-or-range - weight (
longorNone) – Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms. format: int64
-
ADMIN_STATE_DISABLED= 'DISABLED'¶
-
ADMIN_STATE_ENABLED= 'ENABLED'¶
-
ADMIN_STATE_GRACEFUL_DISABLED= 'GRACEFUL_DISABLED'¶
- admin_state (
-
class
com.vmware.nsx_policy.model_client.PoolMemberGroup(customized_members=None, grouping_object=None, ip_revision_filter=None, max_ip_list_size=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - customized_members (
listofPoolMemberSettingorNone) – The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address. - grouping_object (
ResourceReference) – Load balancer pool support grouping object as dynamic pool members. The IP list of the grouping object such as NSGroup would be used as pool member IP setting. - ip_revision_filter (
strorNone) –Possible values are:
PoolMemberGroup.IP_REVISION_FILTER_IPV4PoolMemberGroup.IP_REVISION_FILTER_IPV6PoolMemberGroup.IP_REVISION_FILTER_IPV4_IPV6
Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.
- max_ip_list_size (
longorNone) – The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime. format: int64 - port (
longorNone) – If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case. format: int32
-
IP_REVISION_FILTER_IPV4= 'IPV4'¶
-
IP_REVISION_FILTER_IPV4_IPV6= 'IPV4_IPV6'¶
-
IP_REVISION_FILTER_IPV6= 'IPV6'¶
- customized_members (
-
class
com.vmware.nsx_policy.model_client.PoolMemberSetting(admin_state=None, display_name=None, ip_address=None, port=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe setting is used to add, update or remove pool members from pool. For static pool members, admin_state, display_name and weight can be updated. For dynamic pool members, only admin_state can be updated.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_state (
strorNone) –Possible values are:
PoolMemberSetting.ADMIN_STATE_ENABLEDPoolMemberSetting.ADMIN_STATE_DISABLEDPoolMemberSetting.ADMIN_STATE_GRACEFUL_DISABLED
Member admin state - display_name (
strorNone) – Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail. - ip_address (
str) – Pool member IP address format: ip - port (
strorNone) – Pool member port number format: port-or-range - weight (
longorNone) – Only applicable to static pool members. If supplied for a pool defined by a grouping object, update API would fail. format: int64
-
ADMIN_STATE_DISABLED= 'DISABLED'¶
-
ADMIN_STATE_ENABLED= 'ENABLED'¶
-
ADMIN_STATE_GRACEFUL_DISABLED= 'GRACEFUL_DISABLED'¶
- admin_state (
-
class
com.vmware.nsx_policy.model_client.PoolUsage(allocated_ids=None, free_ids=None, total_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPool usage statistics in a pool.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocated_ids (
longorNone) – Total number of allocated IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - free_ids (
longorNone) – Total number of free IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total_ids (
longorNone) – Total number of IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- allocated_ids (
-
class
com.vmware.nsx_policy.model_client.PortMirroringInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, destination_group=None, direction=None, snap_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMirrors Data from source to destination
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - destination_group (
str) – Data from source group will be copied to members of destination group. - direction (
strorNone) –Possible values are:
PortMirroringInstance.DIRECTION_INGRESSPortMirroringInstance.DIRECTION_EGRESSPortMirroringInstance.DIRECTION_BIDIRECTIONAL
Port mirroring instance direction - snap_length (
longorNone) – If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. format: int32
-
DIRECTION_BIDIRECTIONAL= 'BIDIRECTIONAL'¶
-
DIRECTION_EGRESS= 'EGRESS'¶
-
DIRECTION_INGRESS= 'INGRESS'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PortMirroringInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of port mirroring instances
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPortMirroringInstance) – Port Mirroring Instances list results
- links (
-
class
com.vmware.nsx_policy.model_client.PortMirroringSession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, direction=None, encapsulation_vlan_id=None, mirror_destination=None, mirror_sources=None, preserve_original_vlan=None, session_type=None, snap_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - direction (
str) –Possible values are:
PortMirroringSession.DIRECTION_INGRESSPortMirroringSession.DIRECTION_EGRESSPortMirroringSession.DIRECTION_BIDIRECTIONAL
Port mirroring session direction - encapsulation_vlan_id (
longorNone) – Only for Remote SPAN Port Mirror. format: int64 - mirror_destination (
vmware.vapi.struct.VapiStruct) – Mirror destination When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inMirrorDestination. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inMirrorDestination. - mirror_sources (
listofvmware.vapi.struct.VapiStruct) – Mirror sources When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inMirrorSource. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inMirrorSource. - preserve_original_vlan (
boolorNone) – Only for Remote SPAN Port Mirror. Whether to preserve original VLAN. - session_type (
strorNone) –Possible values are:
PortMirroringSession.SESSION_TYPE_LOGICALPORTMIRRORSESSIONPortMirroringSession.SESSION_TYPE_UPLINKPORTMIRRORSESSIONPortMirroringSession.SESSION_TYPE_RSPANSRCMIRRORSESSIONPortMirroringSession.SESSION_TYPE_RSPANDSTMIRRORSESSIONPortMirroringSession.SESSION_TYPE_LOCALPORTMIRRORSESSIONPortMirroringSession.SESSION_TYPE_LOGICALLOCALPORTMIRRORSESSIONPortMirroringSession.SESSION_TYPE_L3PORTMIRRORSESSION
If this property is unset, this session will be treated as LocalPortMirrorSession.
- snap_length (
longorNone) – If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. format: int64
-
DIRECTION_BIDIRECTIONAL= 'BIDIRECTIONAL'¶
-
DIRECTION_EGRESS= 'EGRESS'¶
-
DIRECTION_INGRESS= 'INGRESS'¶
-
SESSION_TYPE_L3PORTMIRRORSESSION= 'L3PortMirrorSession'¶
-
SESSION_TYPE_LOCALPORTMIRRORSESSION= 'LocalPortMirrorSession'¶
-
SESSION_TYPE_LOGICALLOCALPORTMIRRORSESSION= 'LogicalLocalPortMirrorSession'¶
-
SESSION_TYPE_LOGICALPORTMIRRORSESSION= 'LogicalPortMirrorSession'¶
-
SESSION_TYPE_RSPANDSTMIRRORSESSION= 'RspanDstMirrorSession'¶
-
SESSION_TYPE_RSPANSRCMIRRORSESSION= 'RspanSrcMirrorSession'¶
-
SESSION_TYPE_UPLINKPORTMIRRORSESSION= 'UplinkPortMirrorSession'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PortMirroringSessionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMirror session queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPortMirroringSessionorNone) – Port mirroring session results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.PortMirroringSwitchingProfile(destinations=None, direction=None, key=None, snap_length=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='PortMirroringSwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - destinations (
listofstrorNone) – List of destination addresses format: ip - direction (
strorNone) –Possible values are:
PortMirroringSwitchingProfile.DIRECTION_INGRESSPortMirroringSwitchingProfile.DIRECTION_EGRESSPortMirroringSwitchingProfile.DIRECTION_BIDIRECTIONAL
port mirroring direction - key (
longorNone) – User-configurable 32-bit key format: int64 - snap_length (
longorNone) – If this property not set, original package will not be truncated. format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
-
DIRECTION_BIDIRECTIONAL= 'BIDIRECTIONAL'¶
-
DIRECTION_EGRESS= 'EGRESS'¶
-
DIRECTION_INGRESS= 'INGRESS'¶
- destinations (
-
class
com.vmware.nsx_policy.model_client.PreconfiguredEndpoint(device_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTunnel endpoint configuration of preconfigured host switch
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: device_name ( str) – Name of the virtual tunnel endpoint
-
class
com.vmware.nsx_policy.model_client.PreconfiguredHostSwitch(endpoints=None, host_switch_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPreconfigured host switch is used for manually configured transport node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - endpoints (
listofPreconfiguredEndpointorNone) – List of virtual tunnel endpoints which are preconfigured on this host switch - host_switch_id (
str) – External Id of the preconfigured host switch.
- endpoints (
-
class
com.vmware.nsx_policy.model_client.PreconfiguredHostSwitchSpec(host_switches=None, resource_type='PreconfiguredHostSwitchSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructPreconfigured host switch specification is used for manually configured transport node. It is user’s responsibility to ensure correct configuration is provided to NSX. This type is only valid for supported KVM fabric nodes.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - host_switches (
listofPreconfiguredHostSwitch) – Preconfigured Transport Node host switches - resource_type (
str) –Possible values are:
- host_switches (
-
class
com.vmware.nsx_policy.model_client.PrefixConfig(action=None, ge=None, le=None, network=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
str) –Possible values are:
Action for the IPPrefix - ge (
longorNone) – Greater than or equal to format: int64 - le (
longorNone) – Less than or equal to format: int64 - network (
strorNone) – If absent, the action applies to all addresses. format: ipv4-cidr-block
-
ACTION_DENY= 'DENY'¶
-
ACTION_PERMIT= 'PERMIT'¶
- action (
-
class
com.vmware.nsx_policy.model_client.PrefixEntry(action=None, network=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNetwork prefix entry
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
str) –Possible values are:
Action for the prefix list. - network (
str) – Network prefix in CIDR format. "ANY" matches all networks.
-
ACTION_DENY= 'DENY'¶
-
ACTION_PERMIT= 'PERMIT'¶
- action (
-
class
com.vmware.nsx_policy.model_client.PrefixList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, prefixes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA named list of prefixes for routing purposes.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - prefixes (
listofPrefixEntry) – Specify ordered list of network prefixes.
- links (
-
class
com.vmware.nsx_policy.model_client.PrefixListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of PrefixLists
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPrefixList) – PrefixList results
- links (
-
class
com.vmware.nsx_policy.model_client.Principal(attributes=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: attributes ( listofKeyValue) – Certificate list
-
class
com.vmware.nsx_policy.model_client.PrincipalIdentity(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, is_protected=None, name=None, node_id=None, permission_group=None, role=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - certificate_id (
str) – Id of the stored certificate - is_protected (
boolorNone) – Indicator whether the entities created by this principal should be protected - name (
str) – Name of the principal - node_id (
str) – Unique node-id of a principal - permission_group (
strorNone) –Possible values are:
PrincipalIdentity.PERMISSION_GROUP_READ_ONLY_API_USERSPrincipalIdentity.PERMISSION_GROUP_READ_WRITE_API_USERSPrincipalIdentity.PERMISSION_GROUP_SUPERUSERSPrincipalIdentity.PERMISSION_GROUP_UNDEFINED
Use the ‘role’ field instead and pass in ‘auditor’ for read_only_api_users or ‘enterprise_admin’ for the others.
- role (
strorNone) – Role
-
PERMISSION_GROUP_READ_ONLY_API_USERS= 'read_only_api_users'¶
-
PERMISSION_GROUP_READ_WRITE_API_USERS= 'read_write_api_users'¶
-
PERMISSION_GROUP_SUPERUSERS= 'superusers'¶
-
PERMISSION_GROUP_UNDEFINED= 'undefined'¶
- links (
-
class
com.vmware.nsx_policy.model_client.PrincipalIdentityList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPrincipalIdentity query result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofPrincipalIdentity) – PrincipalIdentity list
- links (
-
class
com.vmware.nsx_policy.model_client.ProcessConnection(dest_element_id=None, number_of_events=None, src_element_id=None, dest_port=None, latency=None, packets_rx=None, packets_tx=None, protocol=None, source_ports=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProcessConnection contains the statistic information of the connection between two processes.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_element_id (
strorNone) – Unique element ID of destination element to which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - number_of_events (
longorNone) – Represents the number of events/flows between the source and destination elements. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_element_id (
strorNone) – Unique element ID of source element from which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dest_port (
longorNone) – Port number of the destination process to which the connection is established by source processes. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - latency (
longorNone) – Time taken for a packet of data to get from source process to destination process. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_rx (
longorNone) – Packets received by destination process format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - packets_tx (
longorNone) – Packets transmitted by source process format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protocol (
strorNone) –Possible values are:
Type of protocol used by the processes for communication. Protocol type can be TCP, UDP or Invalid. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- source_ports (
listoflongorNone) – List of port numbers of all the source processes establishing a connection with destination process. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
PROTOCOL_INVALID= 'INVALID'¶
-
PROTOCOL_TCP= 'TCP'¶
-
PROTOCOL_UDP= 'UDP'¶
- dest_element_id (
-
class
com.vmware.nsx_policy.model_client.ProcessElement(element_id=None, elements=None, resource_name=None, resource_type=None, process_command_line=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProcess element extends from Element class. This class contains the information related to the process.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.PropertyItem(condition=None, field=None, heading=None, label=None, render_configuration=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a label-value pair.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - condition (
strorNone) – If the condition is met then the property will be displayed. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - field (
str) – Represents field value of the property. - heading (
boolorNone) – Set to true if the field is a heading. Default is false. - label (
LabelorNone) – If a field represents a heading, then label is not needed - render_configuration (
listofRenderConfigurationorNone) – Render configuration to be applied, if any. - type (
str) –Possible values are:
Data type of the field.
-
TYPE_DATE= 'Date'¶
-
TYPE_NUMBER= 'Number'¶
-
TYPE_STRING= 'String'¶
-
TYPE_URL= 'Url'¶
- condition (
-
class
com.vmware.nsx_policy.model_client.PublicCloudGatewayNode(allocation_list=None, deployment_config=None, deployment_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, discovered_ip_addresses=None, external_id=None, fqdn=None, ip_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocation_list (
listofstrorNone) – List of logical router ids to which this edge node is allocated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - deployment_config (
EdgeNodeDeploymentConfigorNone) – When this configuration is specified, edge fabric node of deployment_type VIRTUAL_MACHINE will be deployed and registered with MP. - deployment_type (
strorNone) –Possible values are:
EdgeNode.DEPLOYMENT_TYPE_VIRTUAL_MACHINEEdgeNode.DEPLOYMENT_TYPE_PHYSICAL_MACHINEEdgeNode.DEPLOYMENT_TYPE_UNKNOWN
Supported edge deployment type.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – Fabric node type, for example ‘HostNode’, ‘EdgeNode’ or ‘PublicCloudGatewayNode’ - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - discovered_ip_addresses (
listofstrorNone) – Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - external_id (
strorNone) – ID of the Node maintained on the Node and used to recognize the Node - fqdn (
strorNone) – Fully qualified domain name of the fabric node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
- allocation_list (
-
class
com.vmware.nsx_policy.model_client.QosBaseRateShaper(enabled=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA shaper configuration entry that specifies type and metrics
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
bool) – - resource_type (
strorNone) –Possible values are:
-
RESOURCE_TYPE_EGRESSRATESHAPER= 'EgressRateShaper'¶
-
RESOURCE_TYPE_INGRESSBROADCASTRATESHAPER= 'IngressBroadcastRateShaper'¶
-
RESOURCE_TYPE_INGRESSRATESHAPER= 'IngressRateShaper'¶
- enabled (
-
class
com.vmware.nsx_policy.model_client.QosSwitchingProfile(class_of_service=None, dscp=None, shaper_configuration=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='QosSwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - class_of_service (
longorNone) – Class of service format: int32 - dscp (
DscporNone) – - shaper_configuration (
listofQosBaseRateShaperorNone) – - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- class_of_service (
-
class
com.vmware.nsx_policy.model_client.QuickSearchResponse(links=None, schema=None, self_=None, result_count=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - result_count (
long) – Result count format: int64 - results (
listofTypeGroup) – Search results
- links (
-
class
com.vmware.nsx_policy.model_client.RateLimits(enabled=None, rx_broadcast=None, rx_multicast=None, tx_broadcast=None, tx_multicast=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEnables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - enabled (
boolorNone) – Whether rate limiting is enabled - rx_broadcast (
longorNone) – Incoming broadcast traffic limit in packets per second format: int32 - rx_multicast (
longorNone) – Incoming multicast traffic limit in packets per second format: int32 - tx_broadcast (
longorNone) – Outgoing broadcast traffic limit in packets per second format: int32 - tx_multicast (
longorNone) – Outgoing multicast traffic limit in packets per second format: int32
- enabled (
-
class
com.vmware.nsx_policy.model_client.RealizationStateBarrierConfig(links=None, schema=None, self_=None, revision=None, interval=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe configuration data for setting the global realization state barrier
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - interval (
long) – The interval in milliseconds used for auto incrementing the barrier number format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedDiscoverySession(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, message=None, status=None, timestamp=None, topology=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains the realized information of a discovery session.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedDiscoverySession.STATE_UNAVAILABLERealizedDiscoverySession.STATE_UNREALIZEDRealizedDiscoverySession.STATE_REALIZEDRealizedDiscoverySession.STATE_ERROR
Realization state of this object - message (
strorNone) – This property displays the detailed message of the current status of discovery session. The reason for failure will be displayed in case of FAILED status. - status (
strorNone) –Possible values are:
RealizedDiscoverySession.STATUS_STARTEDRealizedDiscoverySession.STATUS_IN_PROGRESSRealizedDiscoverySession.STATUS_FAILEDRealizedDiscoverySession.STATUS_COMPLETEDRealizedDiscoverySession.STATUS_INVALID
Status of discovery session - timestamp (
longorNone) – Timestamp when the data was collected. Unset if the discovery session has started or in-progress or failed state. format: int64 - topology (
TopologyorNone) – Topology
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
-
STATUS_COMPLETED= 'COMPLETED'¶
-
STATUS_FAILED= 'FAILED'¶
-
STATUS_INVALID= 'INVALID'¶
-
STATUS_IN_PROGRESS= 'IN_PROGRESS'¶
-
STATUS_STARTED= 'STARTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedEnforcementPoint(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, realized_firewalls=None, realized_groups=None, realized_services=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Enforcement Point
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedEnforcementPoint.STATE_UNAVAILABLERealizedEnforcementPoint.STATE_UNREALIZEDRealizedEnforcementPoint.STATE_REALIZEDRealizedEnforcementPoint.STATE_ERROR
Realization state of this object - realized_firewalls (
RealizedFirewallsorNone) – Root of Realized Firewalls - realized_groups (
RealizedGroupsorNone) – Root of Realized Groups - realized_services (
RealizedServicesorNone) – Root of Realized Services
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedEnforcementPointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedEnforcementPointorNone) – Paged Collection of Enforcement Point’s
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewall(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedFirewall', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized firewall
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedFirewall.STATE_UNAVAILABLERealizedFirewall.STATE_UNREALIZEDRealizedFirewall.STATE_REALIZEDRealizedFirewall.STATE_ERROR
Realization state of this object
-
RESOURCE_TYPE_REALIZEDFIREWALLSECTION= 'RealizedFirewallSection'¶
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewallRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, action=None, destinations=None, direction=None, disabled=None, services=None, sources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Firewall Rule
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedFirewallRule.STATE_UNAVAILABLERealizedFirewallRule.STATE_UNREALIZEDRealizedFirewallRule.STATE_REALIZEDRealizedFirewallRule.STATE_ERROR
Realization state of this object - action (
strorNone) –Possible values are:
RealizedFirewallRule.ACTION_ALLOWRealizedFirewallRule.ACTION_DROPRealizedFirewallRule.ACTION_REJECT
Action enforced on the packets which matches the firewall rule.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- destinations (
listofResourceReferenceorNone) – List of the destinations. Null will be treated as any. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - direction (
strorNone) –Possible values are:
RealizedFirewallRule.DIRECTION_INRealizedFirewallRule.DIRECTION_OUTRealizedFirewallRule.DIRECTION_IN_OUT
Rule direction in case of stateless firewall rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- disabled (
boolorNone) – Flag to disable rule. Disabled will only be persisted but never provisioned/realized. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - services (
listofResourceReferenceorNone) – List of the services. Null will be treated as any. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sources (
listofResourceReferenceorNone) – List of sources. Null will be treated as any. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REJECT= 'REJECT'¶
-
DIRECTION_IN= 'IN'¶
-
DIRECTION_IN_OUT= 'IN_OUT'¶
-
DIRECTION_OUT= 'OUT'¶
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewallSection(rule_count=None, rules=None, section_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedFirewallSection', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Firewall section
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rules (
listofRealizedFirewallRuleorNone) – List of firewall rules in the section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
strorNone) –Possible values are:
Type of the rules which a section can contain.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedFirewall.STATE_UNAVAILABLERealizedFirewall.STATE_UNREALIZEDRealizedFirewall.STATE_REALIZEDRealizedFirewall.STATE_ERROR
Realization state of this object
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- rule_count (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewallSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedFirewallSectionorNone) – Paged Collection of firewall sections This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewallUIResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, intent_communication_map=None, realized_firewall_sections=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Firewall Sections and associated communication map
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - intent_communication_map (
CommunicationMaporNone) – - realized_firewall_sections (
listofvmware.vapi.struct.VapiStruct) – Realized firewall sections associated to the communication map When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inRealizedFirewall. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inRealizedFirewall.
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewallUIResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of communication map and Realized Firewall Sections Pairs
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedFirewallUIResource) – communication map and realized firewall sections list results
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedFirewalls(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, realized_firewalls=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized firewalls
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedFirewalls.STATE_UNAVAILABLERealizedFirewalls.STATE_UNREALIZEDRealizedFirewalls.STATE_REALIZEDRealizedFirewalls.STATE_ERROR
Realization state of this object - realized_firewalls (
listofvmware.vapi.struct.VapiStructorNone) – list of realized firewalls When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inRealizedFirewall. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inRealizedFirewall. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedGroup(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedGroup', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized group
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedGroup.STATE_UNAVAILABLERealizedGroup.STATE_UNREALIZEDRealizedGroup.STATE_REALIZEDRealizedGroup.STATE_ERROR
Realization state of this object
-
RESOURCE_TYPE_REALIZEDNSGROUP= 'RealizedNSGroup'¶
-
RESOURCE_TYPE_REALIZEDSECURITYGROUP= 'RealizedSecurityGroup'¶
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedGroupUIResource(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, intent_group=None, realized_groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Groups and associated Intent Group
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - intent_group (
GrouporNone) – - realized_groups (
listofGenericPolicyRealizedResource) – Realized groups associated to the intent group
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedGroupUIResourceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Intent and Realized Group Pairs
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedGroupUIResource) – Intent and realized group list results
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedGroups(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, realized_groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized groups
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedGroups.STATE_UNAVAILABLERealizedGroups.STATE_UNREALIZEDRealizedGroups.STATE_REALIZEDRealizedGroups.STATE_ERROR
Realization state of this object - realized_groups (
listofvmware.vapi.struct.VapiStructorNone) – list of realized groups When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inRealizedGroup. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inRealizedGroup. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedIPSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized IPSet
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedIPSet.STATE_UNAVAILABLERealizedIPSet.STATE_UNREALIZEDRealizedIPSet.STATE_REALIZEDRealizedIPSet.STATE_ERROR
Realization state of this object
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedIPSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedIPSetorNone) – Paged Collection of Realized IPSets
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedLogicalPort(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, logical_port_id=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Logical Port
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedLogicalPort.STATE_UNAVAILABLERealizedLogicalPort.STATE_UNREALIZEDRealizedLogicalPort.STATE_REALIZEDRealizedLogicalPort.STATE_ERROR
Realization state of this object - logical_port_id (
strorNone) – The id of the logical port This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
strorNone) –Possible values are:
The Operational status of the logical portThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedLogicalSwitch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, logical_switch_id=None, transport_zone_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Logical Switch
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedLogicalSwitch.STATE_UNAVAILABLERealizedLogicalSwitch.STATE_UNREALIZEDRealizedLogicalSwitch.STATE_REALIZEDRealizedLogicalSwitch.STATE_ERROR
Realization state of this object - logical_switch_id (
strorNone) – Id of the logical switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_zone_id (
strorNone) – Transport zone identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedMACSet(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized MACSet
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedMACSet.STATE_UNAVAILABLERealizedMACSet.STATE_UNREALIZEDRealizedMACSet.STATE_REALIZEDRealizedMACSet.STATE_ERROR
Realization state of this object
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedMACSetListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedMACSetorNone) – Paged Collection of Realized MACSets
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedNSGroup(evaluations=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedNSGroup', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Network and Security Group
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - evaluations (
listofRealizedNSGroupMemberEvaluationorNone) – Reference to the evaluated members of the NSGroup. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedGroup.STATE_UNAVAILABLERealizedGroup.STATE_UNREALIZEDRealizedGroup.STATE_REALIZEDRealizedGroup.STATE_ERROR
Realization state of this object
- evaluations (
-
class
com.vmware.nsx_policy.model_client.RealizedNSGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedNSGrouporNone) – Paged Collection of realized NSGroups This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedNSGroupMemberEvaluation(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, logical_ports=None, logical_switches=None, member_count=None, virtual_machines=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized NSGroup member evaluation
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedNSGroupMemberEvaluation.STATE_UNAVAILABLERealizedNSGroupMemberEvaluation.STATE_UNREALIZEDRealizedNSGroupMemberEvaluation.STATE_REALIZEDRealizedNSGroupMemberEvaluation.STATE_ERROR
Realization state of this object - logical_ports (
listofRealizedLogicalPortorNone) – list of logical ports This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_switches (
listofRealizedLogicalSwitchorNone) – list of logical switches This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - member_count (
longorNone) – Count of the members added to this NSGroup format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - virtual_machines (
listofRealizedVirtualMachineorNone) – list of virtual machines This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedNSService(service_type=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedNSService', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized NSService
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - service_type (
strorNone) –Possible values are:
Realized nsservice typeThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Realized services - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedService.STATE_UNAVAILABLERealizedService.STATE_UNREALIZEDRealizedService.STATE_REALIZEDRealizedService.STATE_ERROR
Realization state of this object
-
SERVICE_TYPE_SERVICE= 'SERVICE'¶
-
SERVICE_TYPE_SERVICE_GROUP= 'SERVICE_GROUP'¶
- service_type (
-
class
com.vmware.nsx_policy.model_client.RealizedNSServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedNSServiceorNone) – Paged Collection of realized services This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedSecurityGroup(evaluations=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedSecurityGroup', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Network and Security Group
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - evaluations (
listofRealizedSecurityGroupMemberEvaluationorNone) – Reference to the evaluted members of the Security Group. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedGroup.STATE_UNAVAILABLERealizedGroup.STATE_UNREALIZEDRealizedGroup.STATE_REALIZEDRealizedGroup.STATE_ERROR
Realization state of this object
- evaluations (
-
class
com.vmware.nsx_policy.model_client.RealizedSecurityGroupListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedSecurityGrouporNone) – Paged Collection of realized Security Groups This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedSecurityGroupMemberEvaluation(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, member_count=None, virtual_machines=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Security Group member evaluation
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedSecurityGroupMemberEvaluation.STATE_UNAVAILABLERealizedSecurityGroupMemberEvaluation.STATE_UNREALIZEDRealizedSecurityGroupMemberEvaluation.STATE_REALIZEDRealizedSecurityGroupMemberEvaluation.STATE_ERROR
Realization state of this object - member_count (
longorNone) – Count of the members added to this Security Group format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - virtual_machines (
listofRealizedVirtualMachineorNone) – list of virtual machines This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedService(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RealizedService', tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Service
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Realized services - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedService.STATE_UNAVAILABLERealizedService.STATE_UNREALIZEDRealizedService.STATE_REALIZEDRealizedService.STATE_ERROR
Realization state of this object
-
RESOURCE_TYPE_REALIZEDNSSERVICE= 'RealizedNSService'¶
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedServices(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, realized_services=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized services
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedServices.STATE_UNAVAILABLERealizedServices.STATE_UNREALIZEDRealizedServices.STATE_REALIZEDRealizedServices.STATE_ERROR
Realization state of this object - realized_services (
listofvmware.vapi.struct.VapiStructorNone) – List of realized services When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inRealizedService. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inRealizedService. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedState(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, enforcement_points=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRoot of realized policy state
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedState.STATE_UNAVAILABLERealizedState.STATE_UNREALIZEDRealizedState.STATE_REALIZEDRealizedState.STATE_ERROR
Realization state of this object - enforcement_points (
listofRealizedEnforcementPointorNone) – Enforcement points for realized policy
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedVirtualMachine(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, alarms=None, intent_reference=None, realization_specific_identifier=None, runtime_status=None, state=None, compute_ids=None, host_id=None, local_id_on_host=None, power_state=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRealized Virtual Machine
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alarms (
listofPolicyAlarmResourceorNone) – Alarm info detail - intent_reference (
listofstrorNone) – Desire state paths of this object - realization_specific_identifier (
strorNone) – Realization id of this object - runtime_status (
strorNone) – Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive. - state (
str) –Possible values are:
RealizedVirtualMachine.STATE_UNAVAILABLERealizedVirtualMachine.STATE_UNREALIZEDRealizedVirtualMachine.STATE_REALIZEDRealizedVirtualMachine.STATE_ERROR
Realization state of this object - compute_ids (
listofstrorNone) – List of external compute ids of the virtual machine in the format ‘id-type-key:value’ , list of external compute ids [‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, ‘instanceUuid:xxxx-xxxx-xxxx-xxxx’] This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_id (
strorNone) – Id of the host on which the vm exists. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_id_on_host (
strorNone) – Id of the vm unique within the host. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - power_state (
strorNone) –Possible values are:
RealizedVirtualMachine.POWER_STATE_VM_RUNNINGRealizedVirtualMachine.POWER_STATE_VM_STOPPEDRealizedVirtualMachine.POWER_STATE_VM_SUSPENDEDRealizedVirtualMachine.POWER_STATE_UNKNOWN
Current power state of this virtual machine in the system.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
POWER_STATE_UNKNOWN= 'UNKNOWN'¶
-
POWER_STATE_VM_RUNNING= 'VM_RUNNING'¶
-
POWER_STATE_VM_STOPPED= 'VM_STOPPED'¶
-
POWER_STATE_VM_SUSPENDED= 'VM_SUSPENDED'¶
-
STATE_ERROR= 'ERROR'¶
-
STATE_REALIZED= 'REALIZED'¶
-
STATE_UNAVAILABLE= 'UNAVAILABLE'¶
-
STATE_UNREALIZED= 'UNREALIZED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RealizedVirtualMachineListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRealizedVirtualMachineorNone) – Paged Collection of VMs
- links (
-
class
com.vmware.nsx_policy.model_client.RedirectionPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None, redirect_to=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of redirection rules along with paths of redirection targets to which the traffic needs to be redirected.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - category (
strorNone) – Policy framework provides four pre-defined categories for classifying a security policy. They are "Emergency", "Infrastructure" "Environmental" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Emergency category has the highest priority followed by Infrastructure, Environmental and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - rules (
listofRedirectionRuleorNone) – RedirectionRules that are a part of this RedirectionPolicy - sequence_number (
longorNone) – - redirect_to (
listofstr) – List of paths to redirection targets. Valid redirection targets could be PolicyServiceInstance, VirtualEndpoint or ServiceInstanceEndpoint.
- links (
-
class
com.vmware.nsx_policy.model_client.RedirectionPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Redirection Policies
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofSecurityPolicy) – SecurityPolicy list results
- links (
-
class
com.vmware.nsx_policy.model_client.RedirectionRule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None, direction=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIt define redirection rule for service insertion
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - action (
strorNone) –Possible values are:
The action to be applied to all the services - destination_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - scope (
listofstrorNone) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs. - sequence_number (
longorNone) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain format: int32 - services (
listofstrorNone) – In order to specify all services, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values. - source_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values. - direction (
strorNone) –Possible values are:
Define direction of traffic
-
ACTION_DO_NOT_REDIRECT= 'DO_NOT_REDIRECT'¶
-
ACTION_REDIRECT= 'REDIRECT'¶
-
DIRECTION_IN= 'IN'¶
-
DIRECTION_IN_OUT= 'IN_OUT'¶
-
DIRECTION_OUT= 'OUT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RedirectionRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of RedirectionRules
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRule) – Rule list results
- links (
-
class
com.vmware.nsx_policy.model_client.RedistributionConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bgp_enabled=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bgp_enabled (
boolorNone) – Flag to enable redistribution for BGP as destinationProtocol - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RedistributionRule(description=None, destination=None, display_name=None, route_map_id=None, sources=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - description (
strorNone) – Description - destination (
str) –Possible values are:
RedistributionRule.DESTINATION_STATICRedistributionRule.DESTINATION_NSX_CONNECTEDRedistributionRule.DESTINATION_NSX_STATICRedistributionRule.DESTINATION_TIER0_NATRedistributionRule.DESTINATION_TIER1_NATRedistributionRule.DESTINATION_TIER1_LB_VIPRedistributionRule.DESTINATION_TIER1_LB_SNATRedistributionRule.DESTINATION_BGP
Destination redistribution protocol - display_name (
strorNone) – Display name - route_map_id (
strorNone) – RouteMap Id for the filter - sources (
listofstr) –Possible values are:
RedistributionRule.SOURCES_STATICRedistributionRule.SOURCES_NSX_CONNECTEDRedistributionRule.SOURCES_NSX_STATICRedistributionRule.SOURCES_TIER0_NATRedistributionRule.SOURCES_TIER1_NATRedistributionRule.SOURCES_TIER1_LB_VIPRedistributionRule.SOURCES_TIER1_LB_SNATRedistributionRule.SOURCES_BGP
Array of redistribution protocols
-
DESTINATION_BGP= 'BGP'¶
-
DESTINATION_NSX_CONNECTED= 'NSX_CONNECTED'¶
-
DESTINATION_NSX_STATIC= 'NSX_STATIC'¶
-
DESTINATION_STATIC= 'STATIC'¶
-
DESTINATION_TIER0_NAT= 'TIER0_NAT'¶
-
DESTINATION_TIER1_LB_SNAT= 'TIER1_LB_SNAT'¶
-
DESTINATION_TIER1_LB_VIP= 'TIER1_LB_VIP'¶
-
DESTINATION_TIER1_NAT= 'TIER1_NAT'¶
-
SOURCES_BGP= 'BGP'¶
-
SOURCES_NSX_CONNECTED= 'NSX_CONNECTED'¶
-
SOURCES_NSX_STATIC= 'NSX_STATIC'¶
-
SOURCES_STATIC= 'STATIC'¶
-
SOURCES_TIER0_NAT= 'TIER0_NAT'¶
-
SOURCES_TIER1_LB_SNAT= 'TIER1_LB_SNAT'¶
-
SOURCES_TIER1_LB_VIP= 'TIER1_LB_VIP'¶
-
SOURCES_TIER1_NAT= 'TIER1_NAT'¶
- description (
-
class
com.vmware.nsx_policy.model_client.RedistributionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rules (
listofRedistributionRuleorNone) – List of redistribution rules. User needs to re-order rules to change the priority.
- links (
-
class
com.vmware.nsx_policy.model_client.RegistrationToken(roles=None, token=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAppliance registration access token
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - roles (
listofstr) – List results - token (
str) – Access token
- roles (
-
class
com.vmware.nsx_policy.model_client.RelatedApiError(details=None, error_code=None, error_data=None, error_message=None, module_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDetailed information about a related API error
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
strorNone) – Further details about the error - error_code (
longorNone) – A numeric error code format: int64 - error_data (
vmware.vapi.struct.VapiStructorNone) – Additional data about the error - error_message (
strorNone) – A description of the error - module_name (
strorNone) – The module name where the error occurred
- details (
-
class
com.vmware.nsx_policy.model_client.RelatedAttribute(attribute=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRelated attribute on the target resource for conditional constraints based on related attribute value. Example - destinationGroups/service/action is related attribute of sourceGroups in communcation entry.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: attribute ( str) – Related attribute name on the target entity.
-
class
com.vmware.nsx_policy.model_client.RelatedAttributeConditionalExpression(condition=None, related_attribute=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RelatedAttributeConditionalExpression', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the leaf level type expression to express constraint as value of realted attribute to the target. Example - Constraint traget attribute ‘X’ (example in Constraint), if destinationGroups contains ‘vCeneter’ then allow only values "HTTPS", "HTTP" for attribute X. { "target":{ "target_resource_type":"CommunicationEntry", "attribute":"services", "path_prefix": "/infra/domains/{{DOMAIN}}/edge-communication-maps/default/communication-entries/" }, "constraint_expression": { "resource_type": "RelatedAttributeConditionalExpression", "related_attribute":{ "attribute":"destinationGroups" }, "condition" : { "operator":"INCLUDES", "rhs_value": ["/infra/domains/mgw/groups/VCENTER"], "value_constraint": { "resource_type": "ValueConstraintExpression", "operator":"INCLUDES", "values":["/infra/services/HTTP", "/infra/services/HTTPS"] } } } }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - condition (
ConditionalValueConstraintExpression) – Conditional value expression for target based on realted attribute value. - related_attribute (
RelatedAttribute) – Related attribute. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
- condition (
-
class
com.vmware.nsx_policy.model_client.RelatedData(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, alias=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe results array will contain all the related objects
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - alias (
strorNone) – Alias for the related type - results (
listofvmware.vapi.struct.VapiStruct) – Array of related objects
- links (
-
class
com.vmware.nsx_policy.model_client.RelatedDataRequest(included_fields=None, alias=None, filters=None, resource_type=None, join_condition=None, size=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRequest parameters for the related types
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - included_fields (
strorNone) – Comma separated list of fields that should be included in query result - alias (
strorNone) – Alias for the response - filters (
listofFilterRequestorNone) – An array of filter conditions - resource_type (
str) – Resource type name - join_condition (
str) – Join condition between the parent and the related object. This is to be specified in "relatedObjectFieldName:ParentObjectFieldName" format. - size (
longorNone) – Number of related objects to return. If not specified all the related objects will be returned. Should be set to 0 if only the count of related objects is desired. format: int64
- included_fields (
-
class
com.vmware.nsx_policy.model_client.RemoteFileServer(directory_path=None, port=None, protocol=None, server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRemote file server
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - directory_path (
str) – Remote server directory to copy bundle files to - port (
longorNone) – Server port format: int64 - protocol (
FileTransferProtocol) – Protocol to use to copy file - server (
str) – Remote server hostname or IP address format: hostname-or-ip
- directory_path (
-
class
com.vmware.nsx_policy.model_client.RemoteServerFingerprint(port=None, server=None, ssh_fingerprint=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRemote server
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - port (
longorNone) – Server port format: int64 - server (
str) – Remote server hostname or IP address format: hostname-or-ip - ssh_fingerprint (
str) – SSH fingerprint of server
- port (
-
class
com.vmware.nsx_policy.model_client.RemoteServerFingerprintRequest(port=None, server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRemote server
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - port (
longorNone) – Server port format: int64 - server (
str) – Remote server hostname or IP address format: hostname-or-ip
- port (
-
class
com.vmware.nsx_policy.model_client.RenderConfiguration(color=None, condition=None, display_value=None, icons=None, tooltip=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRender configuration to be applied to the widget.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - color (
strorNone) –Possible values are:
RenderConfiguration.COLOR_GREYRenderConfiguration.COLOR_SKY_BLUERenderConfiguration.COLOR_BLUERenderConfiguration.COLOR_GREENRenderConfiguration.COLOR_YELLOWRenderConfiguration.COLOR_RED
The color to use when rendering an entity. For example, set color as ‘RED’ to render a portion of donut in red.
- condition (
strorNone) – If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - display_value (
strorNone) – If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured. - icons (
listofIconorNone) – Icons to be applied at dashboard for widgets and UI elements. - tooltip (
listofTooltiporNone) – Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.
-
COLOR_BLUE= 'BLUE'¶
-
COLOR_GREEN= 'GREEN'¶
-
COLOR_GREY= 'GREY'¶
-
COLOR_RED= 'RED'¶
-
COLOR_SKY_BLUE= 'SKY_BLUE'¶
-
COLOR_YELLOW= 'YELLOW'¶
- color (
-
class
com.vmware.nsx_policy.model_client.Resource(links=None, schema=None, self_=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructBase class for resources
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource
- links (
-
class
com.vmware.nsx_policy.model_client.ResourceAllocation(limit=None, reservation=None, shares=None, traffic_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSpecify limit, shares and reservation for all kinds of traffic. Values for limit and reservation are expressed in percentage. And for shares, the value is expressed as a number between 1-100. The overall reservation among all traffic types should not exceed 75%. Otherwise, the API request will be rejected.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - limit (
float) – The limit property specifies the maximum bandwidth allocation for a given traffic type and is expressed in percentage. The default value for this field is set to -1 which means the traffic is unbounded for the traffic type. All other negative values for this property is not supported and will be rejected by the API. - reservation (
float) – Minimum guaranteed bandwidth percentage - shares (
long) – Shares format: int32 - traffic_type (
HostInfraTrafficType) – Resource allocation traffic type
- limit (
-
class
com.vmware.nsx_policy.model_client.ResourceLink(action=None, href=None, rel=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA link to a related resource
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
strorNone) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - href (
strorNone) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rel (
strorNone) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- action (
-
class
com.vmware.nsx_policy.model_client.ResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA weak reference to an NSX resource.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.RestoreConfiguration(passphrase=None, remote_file_server=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructConfiguration where backup files are stored for restore
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - passphrase (
strorNone) – Passphrase used to encrypt backup files. - remote_file_server (
RemoteFileServer) – The server from which backup files will be retrieved for restore.
- passphrase (
-
class
com.vmware.nsx_policy.model_client.RestoreStep(description=None, status=None, step_number=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRestore step info
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - description (
strorNone) – Restore step description This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
PerStepRestoreStatusorNone) – - step_number (
longorNone) – Restore step number format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - value (
strorNone) – Restore step value This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- description (
-
class
com.vmware.nsx_policy.model_client.RevisionedResource(links=None, schema=None, self_=None, revision=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA base class for types that track revisions
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.Role(role=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: role ( str) – Role name
-
class
com.vmware.nsx_policy.model_client.RoleBinding(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, name=None, roles=None, stale=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUser/Group’s role binding
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - name (
strorNone) – User/Group’s name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - roles (
listofRoleorNone) – Roles This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - stale (
strorNone) –Possible values are:
Property ‘stale’ can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding’s state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- type (
strorNone) –Possible values are:
RoleBinding.TYPE_REMOTE_USERRoleBinding.TYPE_REMOTE_GROUPRoleBinding.TYPE_LOCAL_USERRoleBinding.TYPE_PRINCIPAL_IDENTITY
TypeThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STALE_FALSE= 'FALSE'¶
-
STALE_TRUE= 'TRUE'¶
-
STALE_UNKNOWN= 'UNKNOWN'¶
-
TYPE_LOCAL_USER= 'local_user'¶
-
TYPE_PRINCIPAL_IDENTITY= 'principal_identity'¶
-
TYPE_REMOTE_GROUP= 'remote_group'¶
-
TYPE_REMOTE_USER= 'remote_user'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RoleBindingListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRoleBinding) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.RoleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRole) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.RoleWithFeatures(features=None, role=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRole
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - features (
listofFeaturePermission) – Features - role (
strorNone) – Role name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- features (
-
class
com.vmware.nsx_policy.model_client.RouteAggregationEntry(prefix=None, summary_only=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of routes to be aggregated
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - prefix (
str) – CIDR of aggregate address format: ip-cidr-block - summary_only (
boolorNone) – Send only summarized route. Summarization reduces number of routes advertised by representing multiple related routes with prefix property.
- prefix (
-
class
com.vmware.nsx_policy.model_client.RouteBasedIPSecVPNSession(tunnel_ports=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='RouteBasedIPSecVPNSession', tags=None, enabled=None, ipsec_vpn_service_id=None, local_endpoint_id=None, peer_endpoint_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - tunnel_ports (
listofTunnelPortConfig) – IP Tunnel ports. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
IPSecVPNSession.RESOURCE_TYPE_POLICYBASEDIPSECVPNSESSIONIPSecVPNSession.RESOURCE_TYPE_ROUTEBASEDIPSECVPNSESSION
A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - enabled (
boolorNone) – Enable/Disable IPSec VPN session. - ipsec_vpn_service_id (
strorNone) – Identifier of VPN Service linked with local endpoint. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_endpoint_id (
str) – Local endpoint identifier. - peer_endpoint_id (
str) – Peer endpoint identifier.
- tunnel_ports (
-
class
com.vmware.nsx_policy.model_client.RouteBasedL3VpnSession(default_rule_logging=None, force_whitelisting=None, routing_config_path=None, tunnel_subnets=None, resource_type='RouteBasedL3VpnSession')¶ Bases:
vmware.vapi.bindings.struct.VapiStructA Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - default_rule_logging (
boolorNone) – Indicates if logging should be enabled for the default whitelisting rule for the VTI interface. - force_whitelisting (
boolorNone) – The default firewall rule Action is set to DROP if true otherwise set to ALLOW. - routing_config_path (
strorNone) – Policy path referencing the bgp neighbor for a route based L3Vpn. - For an L3Vpn transporting L2Vpn, it is not necessary to provide bgp neighbor configuration. - For an L3Vpn not transporting L2Vpn, this property is necessary. - tunnel_subnets (
listofTunnelSubnet) – Virtual tunnel interface (VTI) port IP subnets to be used to configure route-based L3Vpn session. A max of one tunnel subnet is allowed. - resource_type (
str) –Possible values are:
L3VpnSession.RESOURCE_TYPE_POLICYBASEDL3VPNSESSIONL3VpnSession.RESOURCE_TYPE_ROUTEBASEDL3VPNSESSION
- A Policy Based L3Vpn is a configuration in which protect rules to
match local and remote subnet needs to be defined. Tunnel is established for each pair of local and remote subnet defined in protect rules. - A Route Based L3Vpn is more flexible, more powerful and recommended over policy based. IP Tunnel subnet is created and all traffic routed through tunnel subnet (commonly known as VTI) is sent over tunnel. Routes can be learned through BGP. A route based L3Vpn is required when using redundant L3Vpn.
- default_rule_logging (
-
class
com.vmware.nsx_policy.model_client.RouteMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, sequences=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sequences (
listofRouteMapSequence) – Ordered list of routeMap sequences
- links (
-
class
com.vmware.nsx_policy.model_client.RouteMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRouteMap) – Paginated list of RouteMaps
- links (
-
class
com.vmware.nsx_policy.model_client.RouteMapSequence(action=None, match_criteria=None, set_criteria=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
str) –Possible values are:
Action for the Sequence - match_criteria (
RouteMapSequenceMatch) – Match Criteria for the RouteMap Sequence - set_criteria (
RouteMapSequenceSetorNone) – Set Criteria for the RouteMap Sequence
-
ACTION_DENY= 'DENY'¶
-
ACTION_PERMIT= 'PERMIT'¶
- action (
-
class
com.vmware.nsx_policy.model_client.RouteMapSequenceMatch(ip_prefix_lists=None, match_community_expression=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructMatch sequence in route map which is used for matching routes. IP prefix lists and match community expression are mutually exclusive fields, one of them must be provided.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_prefix_lists (
listofstrorNone) – IPPrefixList Identifiers for RouteMap Sequence Match Criteria - match_community_expression (
CommunityMatchExpressionorNone) – It supports conjunction operator (AND) and five operators within singular community match expression (MATCH_ANY, MATCH_ALL, MATCH_EXACT, MATCH_NONE, MATCH_REGEX).
- ip_prefix_lists (
-
class
com.vmware.nsx_policy.model_client.RouteMapSequenceSet(as_path_prepend=None, community=None, multi_exit_discriminator=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - as_path_prepend (
strorNone) – As Path Prepending to influence path selection - community (
strorNone) – Either well-known community name or community value in aa:nn(2byte:2byte) format - multi_exit_discriminator (
longorNone) – Multi Exit Discriminator (MED) format: int64 - weight (
longorNone) – Weight used to select certain path format: int32
- as_path_prepend (
-
class
com.vmware.nsx_policy.model_client.RouterNexthop(admin_distance=None, ip_address=None, scope=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNext hop configuration for network
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_distance (
longorNone) – Cost associated with next hop route. format: int32 - ip_address (
strorNone) – Next hop gateway IP address. format: ip - scope (
listofstrorNone) – Interface path associated with current route.
- admin_distance (
-
class
com.vmware.nsx_policy.model_client.RoutingConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, forwarding_up_timer=None, logical_router_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - forwarding_up_timer (
longorNone) – Defines the extra time the router must wait before sending the UP notification after the first BGP session is established. Default means forward immediately. format: int64 - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.RoutingEntry(admin_distance=None, network=None, next_hop=None, route_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRouting table entry.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - admin_distance (
longorNone) – Admin distance. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - network (
strorNone) – Network CIDR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - next_hop (
strorNone) – Next hop address. format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - route_type (
strorNone) – Network address CIDR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- admin_distance (
-
class
com.vmware.nsx_policy.model_client.RoutingTable(count=None, edge_node=None, route_entries=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRouting table.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - count (
longorNone) – Entry count. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - edge_node (
strorNone) – Transport node ID. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - route_entries (
listofRoutingEntry) – Route entries.
- count (
-
class
com.vmware.nsx_policy.model_client.RoutingTableListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRoutingTableorNone) – Paged Collection of Routes per transport node ID.
- links (
-
class
com.vmware.nsx_policy.model_client.RowListField(alias=None, path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRoot of the api result set for forming rows.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - alias (
strorNone) – - path (
str) – JSON path to the root of the api result set for forming rows.
- alias (
-
class
com.vmware.nsx_policy.model_client.Rule(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, action=None, destination_groups=None, logged=None, scope=None, sequence_number=None, services=None, source_groups=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA rule indicates the action to be performed for various types of traffic flowing between workload groups.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - action (
strorNone) –Possible values are:
The action to be applied to all the services - destination_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - scope (
listofstrorNone) – The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs. - sequence_number (
longorNone) – This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain format: int32 - services (
listofstrorNone) – In order to specify all services, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values. - source_groups (
listofstrorNone) – We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant "ANY". This is case insensitive. If "ANY" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REJECT= 'REJECT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.RuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Rules
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofRule) – Rule list results
- links (
-
class
com.vmware.nsx_policy.model_client.RuleState(details=None, failure_code=None, failure_message=None, state=None, revision_desired=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
RuleState.STATE_PENDINGRuleState.STATE_IN_PROGRESSRuleState.STATE_SUCCESSRuleState.STATE_FAILEDRuleState.STATE_PARTIAL_SUCCESSRuleState.STATE_ORPHANEDRuleState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- revision_desired (
longorNone) – revision number of the desired state format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.SVMDeploymentSpec(host_type=None, name=None, ovf_url=None, service_form_factor=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDeployment Specs holds information required to deploy the Service-VMs.i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF(Open Virtualization Format) can be deployed, Form factor to name a few.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - host_type (
str) –Possible values are:
SVMDeploymentSpec.HOST_TYPE_ESXISVMDeploymentSpec.HOST_TYPE_RHELKVMSVMDeploymentSpec.HOST_TYPE_UBUNTUKVM
Host Type on which the specified OVF can be deployed. - name (
strorNone) – Deployment Spec name for ease of use, since multiple DeploymentSpec can be specified. - ovf_url (
str) – Location of the partner VM OVF to be deployed. - service_form_factor (
strorNone) –Possible values are:
SVMDeploymentSpec.SERVICE_FORM_FACTOR_SMALLSVMDeploymentSpec.SERVICE_FORM_FACTOR_MEDIUMSVMDeploymentSpec.SERVICE_FORM_FACTOR_LARGE
Supported ServiceInsertion Form Factor for the OVF deployment. The default FormFactor is Medium.
-
HOST_TYPE_ESXI= 'ESXI'¶
-
HOST_TYPE_RHELKVM= 'RHELKVM'¶
-
HOST_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
-
SERVICE_FORM_FACTOR_LARGE= 'LARGE'¶
-
SERVICE_FORM_FACTOR_MEDIUM= 'MEDIUM'¶
-
SERVICE_FORM_FACTOR_SMALL= 'SMALL'¶
- host_type (
-
class
com.vmware.nsx_policy.model_client.SavedSearch(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - is_saved (
bool) – The flag indicates whether the saved query is saved search or recent search. - query (
str) – The search query that is to be saved.
- links (
-
class
com.vmware.nsx_policy.model_client.SavedSearchListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe results array will contain all the saved or recent search objects.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofSavedSearch) – The list of all saved searches by the user.
- links (
-
class
com.vmware.nsx_policy.model_client.SavedSearchRequest(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, is_saved=None, query=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe request will contain the query to be saved and the flag indicating whether it is recent or saved search.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - is_saved (
bool) – The flag indicates whether the query is recent or saved search. - query (
str) – The search query that has to be saved.
- links (
-
class
com.vmware.nsx_policy.model_client.SearchResponse(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – Search results
- links (
-
class
com.vmware.nsx_policy.model_client.SecurityPolicy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, category=None, rules=None, sequence_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of Rules. This object is created by default along with the Domain.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - category (
strorNone) – Policy framework provides four pre-defined categories for classifying a security policy. They are "Emergency", "Infrastructure" "Environmental" and "Application". There is a pre-determined order in which the policy framework manages the priority of these security policies. Emergency category has the highest priority followed by Infrastructure, Environmental and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - rules (
listofRuleorNone) – Rules that are a part of this SecurityPolicy - sequence_number (
longorNone) –
- links (
-
class
com.vmware.nsx_policy.model_client.SecurityPolicyListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of security policies
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofSecurityPolicy) – SecurityPolicy list results
- links (
-
class
com.vmware.nsx_policy.model_client.Segment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, advanced_config=None, domain_name=None, l2_extension=None, ls_id=None, overlay_id=None, subnets=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSegment configuration to attach workloads.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - advanced_config (
SegmentAdvancedConfigorNone) – Advanced configuration for Segment. - domain_name (
strorNone) – DNS domain name - l2_extension (
L2ExtensionorNone) – Configuration for extending Segment through L2 VPN - ls_id (
strorNone) – Sepcify pre-creted logical switch id for Segment. - overlay_id (
longorNone) – Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point. format: int32 - subnets (
listofSegmentSubnetorNone) – Subnet configuration. Max 1 subnet - type (
strorNone) –Possible values are:
Segment type based on configuration.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
TYPE_DISCONNECTED= 'DISCONNECTED'¶
-
TYPE_EXTENDED= 'EXTENDED'¶
-
TYPE_ROUTED= 'ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.SegmentAdvancedConfig(connectivity=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAdvanced configuration for Segment
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: connectivity ( strorNone) –Possible values are:
Connectivity configuration to manually connect (ON) or disconnect (OFF) a logical entity from network topology.
-
CONNECTIVITY_OFF= 'OFF'¶
-
CONNECTIVITY_ON= 'ON'¶
-
-
class
com.vmware.nsx_policy.model_client.SegmentListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Segments
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofSegment) – Segment list results
- links (
-
class
com.vmware.nsx_policy.model_client.SegmentSubnet(dhcp_ranges=None, gateway_address=None, network=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSubnet configuration for segment
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dhcp_ranges (
listofstrorNone) – DHCP address ranges are used for dynamic IP allocation. Supports address range and CIDR formats. First valid host address from the first value is assigned to DHCP server IP address. Existing values cannot be deleted or modified, but additional DHCP ranges can be added. format: address-or-block-or-range - gateway_address (
strorNone) – Gateway IP address in CIDR format for both IPv4 and IPv6. format: ip-cidr-block - network (
strorNone) – Network CIDR for this subnet calculated from gateway_addresses and prefix_len. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- dhcp_ranges (
-
class
com.vmware.nsx_policy.model_client.SelectableResourceReference(is_valid=None, target_display_name=None, target_id=None, target_type=None, selected=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructResources to take action on
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - selected (
bool) – Set to true if this resource has been selected to be acted upon
- is_valid (
-
class
com.vmware.nsx_policy.model_client.SelfResourceLink(action=None, href=None, rel=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe server will populate this field when returing the resource. Ignored on PUT and POST.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - action (
strorNone) – Optional action This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - href (
strorNone) – Link to resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rel (
strorNone) – Custom relation type (follows RFC 5988 where appropriate definitions exist) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- action (
-
class
com.vmware.nsx_policy.model_client.ServerSslProfileBinding(certificate_chain_depth=None, client_certificate_id=None, server_auth=None, server_auth_ca_ids=None, server_auth_crl_ids=None, ssl_profile_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - certificate_chain_depth (
longorNone) – authentication depth is used to set the verification depth in the server certificates chain. format: int64 - client_certificate_id (
strorNone) – To support client authentication (load balancer acting as a client authenticating to the backend server), client certificate can be specified in the server-side SSL profile binding - server_auth (
strorNone) –Possible values are:
server authentication mode - server_auth_ca_ids (
listofstrorNone) – If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified. - server_auth_crl_ids (
listofstrorNone) – A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates. - ssl_profile_id (
strorNone) – Server SSL profile defines reusable, application-independent server side SSL properties.
-
SERVER_AUTH_IGNORE= 'IGNORE'¶
-
SERVER_AUTH_REQUIRED= 'REQUIRED'¶
- certificate_chain_depth (
-
class
com.vmware.nsx_policy.model_client.Service(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, service_entries=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUsed while defining a CommunicationEntry. A service may have multiple service entries.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_entries (
listofvmware.vapi.struct.VapiStruct) – Service type When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inServiceEntry.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceAssociationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, service_type='ServiceAssociationListResult')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service_type (
str) –Possible values are:
-
SERVICE_TYPE_FIREWALLSERVICEASSOCIATIONLISTRESULT= 'FireWallServiceAssociationListResult'¶
-
SERVICE_TYPE_IPFIXSERVICEASSOCIATIONLISTRESULT= 'IpfixServiceAssociationListResult'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceAttachment(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attachment_status=None, deployed_to=None, local_ips=None, logical_switch=None, service_port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceAttachment represents a point on NSX entity (Example - Edge Router) to which ServiceInstance can be connected through an InstanceEndpoint. Example - In VMWare Hybric Cloud Extention (HCX) use case, HCX appliances connect to this Service Attachment Point. We do not handle the lifecycle of these appliance/s.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - attachment_status (
strorNone) –Possible values are:
UP - A Service Attachment will have its Service Port - UP and with a configured IP address. DOWN - An Inactive ServiceAttachment has its Service Port - DOWN. It can be used to connect set of appliances that do not need to exchange traffic to/from/through the Edge node.
- deployed_to (
ResourceReference) – NSX Resource where we want to create Service Attachment Point. Ex. T0 LR Edge in case of HCX-ServiceInsertion. - local_ips (
listofIPInfo) – Local IPs associated with this Service Attachment. - logical_switch (
ResourceReferenceorNone) – Logical Switch gets created as a part of Service Attachment creation. If a Logical Switch is provided, then that needs to be used - instead of creating new one. - service_port (
ResourceReferenceorNone) – Service Port gets created as a part of Service Attachment creation. It is a Logical Router Port of type CentralizedServicePort. It does not participate in distributed routing. Stateless Policy Based Routing service can be applied on this port.
-
ATTACHMENT_STATUS_DOWN= 'DOWN'¶
-
ATTACHMENT_STATUS_UP= 'UP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceAttachmentListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of Service Attachments.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceAttachmentorNone) – List of the Service Attachments. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceBinding(service_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: service_id ( ResourceReference) – Identifier of Logical Service
-
class
com.vmware.nsx_policy.model_client.ServiceDefinition(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, attachment_point=None, functionalities=None, implementations=None, on_failure_policy=None, service_deployment_spec=None, transports=None, vendor_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRegistering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - attachment_point (
listofstr) –Possible values are:
The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance.
- functionalities (
listofstr) –Possible values are:
ServiceDefinition.FUNCTIONALITIES_NG_FWServiceDefinition.FUNCTIONALITIES_IDS_IPSServiceDefinition.FUNCTIONALITIES_HCX
The capabilities provided by the services like NG_FW, IDS_IPS Hybrid Cloud Exchange(HCX) is specified here.
- implementations (
listofstr) –Possible values are:
This indicates the insertion point of the service. - on_failure_policy (
strorNone) –Possible values are:
Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios.
- service_deployment_spec (
ServiceDeploymentSpecorNone) – Service Deployment Specification defines takes in information required to deploy and configure a partner appliance/service-vm. - transports (
listofstr) –Possible values are:
Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance.
- vendor_id (
str) – Id which is unique to a vendor or partner for which the service is created.
-
ATTACHMENT_POINT_TIER0_LR= 'TIER0_LR'¶
-
ATTACHMENT_POINT_TIER1_LR= 'TIER1_LR'¶
-
FUNCTIONALITIES_HCX= 'HCX'¶
-
FUNCTIONALITIES_IDS_IPS= 'IDS_IPS'¶
-
FUNCTIONALITIES_NG_FW= 'NG_FW'¶
-
IMPLEMENTATIONS_EAST_WEST= 'EAST_WEST'¶
-
IMPLEMENTATIONS_NORTH_SOUTH= 'NORTH_SOUTH'¶
-
ON_FAILURE_POLICY_ALLOW= 'ALLOW'¶
-
ON_FAILURE_POLICY_BLOCK= 'BLOCK'¶
-
TRANSPORTS_L2_BRIDGE= 'L2_BRIDGE'¶
-
TRANSPORTS_L3_ROUTED= 'L3_ROUTED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceDeploymentSpec(deployment_specs=None, deployment_template=None, nic_metadata_list=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - deployment_specs (
listofSVMDeploymentSpecorNone) – Deployment Specs holds information required to deploy the Service-VMs. i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF can be deployed, Form factor to name a few. - deployment_template (
listofDeploymentTemplate) – Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX Manager. - nic_metadata_list (
listofNicMetadataorNone) – NIC metadata associated with the deployment spec.
- deployment_specs (
-
class
com.vmware.nsx_policy.model_client.ServiceElement(element_id=None, elements=None, resource_name=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructNetwork services such as Loadbalancer, DHCP will be represented using this type.
Tip
The arguments are used to initialize data attributes with the same names.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
-
-
class
com.vmware.nsx_policy.model_client.ServiceEndpoint(certificate=None, certificate_sha256_thumbprint=None, fqdn=None, ip_address=None, port=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - certificate (
strorNone) – - certificate_sha256_thumbprint (
strorNone) – - fqdn (
strorNone) – - ip_address (
str) – IPv4 or IPv6 address format: ip - port (
long) –
- certificate (
-
class
com.vmware.nsx_policy.model_client.ServiceEntry(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceEntry', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAn Service entry that describes traffic
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_ALGTYPESERVICEENTRY= 'ALGTypeServiceEntry'¶
-
RESOURCE_TYPE_ICMPTYPESERVICEENTRY= 'ICMPTypeServiceEntry'¶
-
RESOURCE_TYPE_IGMPTYPESERVICEENTRY= 'IGMPTypeServiceEntry'¶
-
RESOURCE_TYPE_IPPROTOCOLSERVICEENTRY= 'IPProtocolServiceEntry'¶
-
RESOURCE_TYPE_L4PORTSETSERVICEENTRY= 'L4PortSetServiceEntry'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceEntryListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Service entries
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStruct) – Service entry list results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inServiceEntry. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inServiceEntry.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceIP(ip_address=None, is_advertised=None, is_arp_proxy_enabled=None, is_loopback_enabled=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_address (
strorNone) – Service IP address registerd by the service. format: ipv4 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_advertised (
boolorNone) – Flag to denote advertisement status of service IP to TIER0 LR. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_arp_proxy_enabled (
boolorNone) – Flag to denote status of ARP Proxy for service IP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_loopback_enabled (
boolorNone) – Flag to denote loopback status for service IP. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - service (
ResourceReferenceorNone) – Service which registered the ip.
- ip_address (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionRule(links=None, schema=None, self_=None, revision=None, owner=None, description=None, display_name=None, id=None, resource_type=None, action=None, applied_tos=None, destinations=None, destinations_excluded=None, direction=None, disabled=None, ip_protocol=None, is_default=None, logged=None, notes=None, rule_tag=None, services=None, sources=None, sources_excluded=None, redirect_tos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructServiceInsertion Rule.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - owner (
OwnerResourceLinkorNone) – Owner of this resource - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Identifier of the resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - action (
str) –Possible values are:
ServiceInsertionRule.ACTION_ALLOWServiceInsertionRule.ACTION_DROPServiceInsertionRule.ACTION_REJECTServiceInsertionRule.ACTION_REDIRECTServiceInsertionRule.ACTION_DO_NOT_REDIRECT
Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP - Drop any packet when a rule with this action gets a match. Packets won’t go further(Used by Firewall). REJECT - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion).
- applied_tos (
listofResourceReferenceorNone) – List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any. - destinations (
listofResourceReferenceorNone) – List of the destinations. Null will be treated as any. - destinations_excluded (
boolorNone) – Negation of the destination. - direction (
strorNone) –Possible values are:
ServiceInsertionRule.DIRECTION_INServiceInsertionRule.DIRECTION_OUTServiceInsertionRule.DIRECTION_IN_OUT
Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.
- disabled (
boolorNone) – Flag to disable rule. Disabled will only be persisted but never provisioned/realized. - ip_protocol (
strorNone) –Possible values are:
ServiceInsertionRule.IP_PROTOCOL_IPV4ServiceInsertionRule.IP_PROTOCOL_IPV6ServiceInsertionRule.IP_PROTOCOL_IPV4_IPV6
Type of IP packet that should be matched while enforcing the rule. - is_default (
boolorNone) – Flag to indicate whether rule is default. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logged (
boolorNone) – Flag to enable packet logging. Default is disabled. - notes (
strorNone) – User notes specific to the rule. - rule_tag (
strorNone) – User level field which will be printed in CLI and packet logs. - services (
listofServiceInsertionServiceorNone) – List of the services. Null will be treated as any. - sources (
listofResourceReferenceorNone) – List of sources. Null will be treated as any. - sources_excluded (
boolorNone) – Negation of the source. - redirect_tos (
listofResourceReference) – A rule can be realized on a particular service definition, service instance or instance endpoint. If a service definition is selected as a redirect_to target, by default it will take the first deployed service instance if finds.
-
ACTION_ALLOW= 'ALLOW'¶
-
ACTION_DO_NOT_REDIRECT= 'DO_NOT_REDIRECT'¶
-
ACTION_DROP= 'DROP'¶
-
ACTION_REDIRECT= 'REDIRECT'¶
-
ACTION_REJECT= 'REJECT'¶
-
DIRECTION_IN= 'IN'¶
-
DIRECTION_IN_OUT= 'IN_OUT'¶
-
DIRECTION_OUT= 'OUT'¶
-
IP_PROTOCOL_IPV4= 'IPV4'¶
-
IP_PROTOCOL_IPV4_IPV6= 'IPV4_IPV6'¶
-
IP_PROTOCOL_IPV6= 'IPV6'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionRuleListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of ServiceInsertion Rules.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceInsertionRuleorNone) – ServiceInsertion rule list result with pagination support. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionSection(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceInsertion section composed of ServiceInsertion Rules.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo. - is_default (
boolorNone) – It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
str) –Possible values are:
ServiceInsertionSection.SECTION_TYPE_LAYER2ServiceInsertionSection.SECTION_TYPE_LAYER3ServiceInsertionSection.SECTION_TYPE_L3REDIRECT
Type of the rules which a section can contain. Only homogeneous sections are supported.
- stateful (
bool) – Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.
-
SECTION_TYPE_L3REDIRECT= 'L3REDIRECT'¶
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionSectionListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of ServiceInsertion Sections.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceInsertionSectionorNone) – List of the ServiceInsertion sections. The list has to be homogeneous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionSectionRuleList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, applied_tos=None, is_default=None, rule_count=None, section_type=None, stateful=None, rules=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of ServiceInsertion Rules.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - applied_tos (
listofResourceReferenceorNone) – List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo. - is_default (
boolorNone) – It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rule_count (
longorNone) – Number of rules in this section. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - section_type (
str) –Possible values are:
ServiceInsertionSectionRuleList.SECTION_TYPE_LAYER2ServiceInsertionSectionRuleList.SECTION_TYPE_LAYER3ServiceInsertionSectionRuleList.SECTION_TYPE_L3REDIRECT
Type of the rules which a section can contain. Only homogeneous sections are supported.
- stateful (
bool) – Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless. - rules (
listofServiceInsertionRule) – List of Service Insertion rules in the section. Only homogeneous rules are supported.
-
SECTION_TYPE_L3REDIRECT= 'L3REDIRECT'¶
-
SECTION_TYPE_LAYER2= 'LAYER2'¶
-
SECTION_TYPE_LAYER3= 'LAYER3'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionService(is_valid=None, target_display_name=None, target_id=None, target_type=None, service=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProtocol on which a particular ServiceInsertion Rule should apply to.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - is_valid (
boolorNone) – Will be set to false if the referenced NSX resource has been deleted. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_display_name (
strorNone) – Display name of the NSX resource. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_id (
strorNone) – Identifier of the NSX resource. - target_type (
strorNone) – Type of the NSX resource. - service (
vmware.vapi.struct.VapiStructorNone) – Distributed Service API accepts raw protocol and ports as part of NS service element in Distributed Service Rule that describes traffic corresponding to an NSService. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inNSServiceElement. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inNSServiceElement.
- is_valid (
-
class
com.vmware.nsx_policy.model_client.ServiceInsertionServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructService List
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceDefinitionorNone) – List of the Service-Insertion Services. The list has to be homogenous. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInstance(attachment_point=None, deployed_to=None, deployment_mode=None, deployment_spec_name=None, implementation_type=None, instance_deployment_config=None, instance_deployment_template=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe deployment of a registered service. Service instance is instantiation of service. It is the most used type of instance. It is a default instance to be used when NSX handles lifecycle of appliance. Deployment and appliance related all the information is necessary.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - attachment_point (
str) –Possible values are:
Attachment point to be used by this service instance for deploying the Service-VM.
- deployed_to (
listofResourceReference) – List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion. - deployment_mode (
str) –Possible values are:
Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.
- deployment_spec_name (
str) – Name of the deployment spec to be used by this service instance. - implementation_type (
str) –Possible values are:
Implementation to be used by this service instance for deploying the Service-VM.
- instance_deployment_config (
InstanceDeploymentConfig) – Instance Deployment Config contains the information to be injected during Service-VM deployment. - instance_deployment_template (
DeploymentTemplate) – The deployment template to be used by this service instance. The attribute values specific to this instance can be added. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
BaseServiceInstance.RESOURCE_TYPE_SERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_BYODSERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_VIRTUALSERVICEINSTANCE
ServiceInstance is used when NSX handles the lifecyle of appliance. Deployment and appliance related all the information is necessary. ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a custom instance to be used when NSX is not handling the lifecycle of an appliance and when the user is not bringing their own appliance.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - on_failure_policy (
strorNone) –Possible values are:
Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.
- service_id (
strorNone) – The Service to which the service instance is associated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_type (
str) –Possible values are:
Transport to be used by this service instance for deploying the Service-VM.
-
ATTACHMENT_POINT_TIER0_LR= 'TIER0_LR'¶
-
ATTACHMENT_POINT_TIER1_LR= 'TIER1_LR'¶
-
DEPLOYMENT_MODE_ACTIVE_STANDBY= 'ACTIVE_STANDBY'¶
-
DEPLOYMENT_MODE_STAND_ALONE= 'STAND_ALONE'¶
-
IMPLEMENTATION_TYPE_EAST_WEST= 'EAST_WEST'¶
-
IMPLEMENTATION_TYPE_NORTH_SOUTH= 'NORTH_SOUTH'¶
- attachment_point (
-
class
com.vmware.nsx_policy.model_client.ServiceInstanceEndpoint(service_interface_path=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ServiceInstanceEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA ServiceInstanceEndpoint belongs to one ByodPolicyServiceInstance and is attached to one ServiceInterface. A ServiceInstanceEndpoint represents a redirection target for a RedirectionPolicy.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - service_interface_path (
str) – Path of Service Interface to which this ServiceInstanceEndpoint is connected. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_ips (
listofIPInfo) – IPs where either inbound or outbound traffic is to be redirected.
- service_interface_path (
-
class
com.vmware.nsx_policy.model_client.ServiceInstanceEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of ServiceInstanceEndpoint
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceInstanceEndpoint) – ServiceInstanceEndpoint list results
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInstanceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructService Instance List
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – List of the Service-Insertion ServicesInstances. The list has to be homogenous. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inBaseServiceInstance. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inBaseServiceInstance. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInterface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructService interface configuration for internal connectivity.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofInterfaceSubnet) – Specify IP address and network prefix for interface.
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Service Interfaces
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceInterface) – Service Interface list results
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Services
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofService) – Service list results
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, server_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
Resource type of the service profile - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - server_addresses (
listofstr) –
-
RESOURCE_TYPE_DHCPRELAYPROFILE= 'DhcpRelayProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceProfile) – service profile list results
- links (
-
class
com.vmware.nsx_policy.model_client.ServiceiPsListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofServiceIPorNone) – List of service IPs registered with the LR by services like NAT, LB, VPN, etc. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.SpoofGuardSwitchingProfile(white_list_providers=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='SpoofGuardSwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSpoofGuard configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - white_list_providers (
listofstr) –Possible values are:
SpoofGuardSwitchingProfile.WHITE_LIST_PROVIDERS_LPORT_BINDINGSList of providers for white listed address bindings.
- links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
-
WHITE_LIST_PROVIDERS_LPORT_BINDINGS= 'LPORT_BINDINGS'¶
-
WHITE_LIST_PROVIDERS_LSWITCH_BINDINGS= 'LSWITCH_BINDINGS'¶
- white_list_providers (
-
class
com.vmware.nsx_policy.model_client.StandardHostSwitch(cpu_config=None, host_switch_name=None, host_switch_profile_ids=None, ip_assignment_spec=None, pnics=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructStandard host switch specification
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - cpu_config (
listofCpuCoreConfigForEnhancedNetworkingStackSwitchorNone) – CPU configuration specifies number of Logical cpu cores (Lcores) per Non Uniform Memory Access (NUMA) node dedicated to Enhanced Networking Stack enabled HostSwitch to get the best performance. - host_switch_name (
strorNone) – If this name is unset or empty then the default host switch name will be used. The name must be unique among all host switches specified in a given transport node; unset name, empty name and the default host switch name are considered the same in terms of uniqueness. - host_switch_profile_ids (
listofHostSwitchProfileTypeIdEntryorNone) – host switch profiles bound to this host switch. If a profile ID is not provided for any HostSwitchProfileType that is supported by the transport node, the corresponding default profile will be bound to the host switch. - ip_assignment_spec (
vmware.vapi.struct.VapiStructorNone) – IPs can come from either a static IP pool or an explicitly specified IP list or DHCP. In case a list of IP is specified, the number of IPs provided should be sufficient as per teaming policy associated with host switch uplink profile. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inIpAssignmentSpec. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inIpAssignmentSpec. - pnics (
listofPnicorNone) – Physical NICs connected to the host switch
- cpu_config (
-
class
com.vmware.nsx_policy.model_client.StandardHostSwitchSpec(host_switches=None, resource_type='StandardHostSwitchSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructStandard host switch specification is used for NSX configured transport node.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - host_switches (
listofStandardHostSwitch) – Transport Node host switches - resource_type (
str) –Possible values are:
- host_switches (
-
class
com.vmware.nsx_policy.model_client.StatItem(drilldown_id=None, tooltip=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDisplayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. - tooltip (
listofTooltiporNone) – Multi-line text to be shown on tooltip while hovering over the stat. - value (
str) – Expression for stat to be displayed.
- drilldown_id (
-
class
com.vmware.nsx_policy.model_client.StaticARPConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, ip_address=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains Static ARP configuration for Segment.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_address (
str) – IP Address format: ip - mac_address (
str) – MAC Address
- links (
-
class
com.vmware.nsx_policy.model_client.StaticHopBfdPeer(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, bfd_config=None, enabled=None, peer_ip_address=None, source_addresses=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - bfd_config (
BfdConfigParametersorNone) – If not specified then BFD peer will inherit configuration from the BFD global config. - enabled (
boolorNone) – Indicate BFD peer is enabled or disabled. Default is true. - peer_ip_address (
str) – IP address of BFD peer. This should be same as next hop IP address. format: ipv4 - source_addresses (
listofstrorNone) – BFD peers will be created from all these source addresses to this neighbour. format: ipv4
- links (
-
class
com.vmware.nsx_policy.model_client.StaticHopBfdPeerListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofStaticHopBfdPeerorNone) – static hop BFD peer list results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.StaticIpListSpec(default_gateway=None, ip_list=None, subnet_mask=None, resource_type='StaticIpListSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructIP assignment specification for Static IP List.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - default_gateway (
str) – Gateway IP format: ip - ip_list (
listofstr) – List of IPs for transport node host switch virtual tunnel endpoints format: ip - subnet_mask (
str) – Subnet mask format: ip - resource_type (
str) –Possible values are:
- default_gateway (
-
class
com.vmware.nsx_policy.model_client.StaticIpMacListSpec(default_gateway=None, ip_mac_list=None, subnet_mask=None, resource_type='StaticIpMacListSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructIP and MAC assignment specification for Static IP List.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - default_gateway (
str) – Gateway IP format: ip - ip_mac_list (
listofIpMacPair) – List of IPs and MACs for transport node host switch virtual tunnel endpoints - subnet_mask (
str) – Subnet mask format: ip - resource_type (
str) –Possible values are:
- default_gateway (
-
class
com.vmware.nsx_policy.model_client.StaticIpPoolSpec(ip_pool_id=None, resource_type='StaticIpPoolSpec')¶ Bases:
vmware.vapi.bindings.struct.VapiStructIP assignment specification for Static IP Pool.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_pool_id (
str) – - resource_type (
str) –Possible values are:
- ip_pool_id (
-
class
com.vmware.nsx_policy.model_client.StaticRoute(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, logical_router_id=None, network=None, next_hops=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - logical_router_id (
strorNone) – Logical router id This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - network (
str) – CIDR format: ipv4-cidr-block - next_hops (
listofStaticRouteNextHop) – Next Hops
- links (
-
class
com.vmware.nsx_policy.model_client.StaticRouteListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofStaticRoute) – Paginated list of static routes
- links (
-
class
com.vmware.nsx_policy.model_client.StaticRouteNextHop(administrative_distance=None, bfd_enabled=None, blackhole_action=None, ip_address=None, logical_router_port_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - administrative_distance (
longorNone) – Administrative Distance for the next hop IP format: int64 - bfd_enabled (
boolorNone) – Status of bfd for this next hop where bfd_enabled = true indicate bfd is enabled for this next hop and bfd_enabled = false indicate bfd peer is disabled or not configured for this next hop. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - blackhole_action (
strorNone) –Possible values are:
Action to be taken on matching packets for NULL routes.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ip_address (
strorNone) – Next Hop IP format: ipv4 - logical_router_port_id (
ResourceReferenceorNone) – Reference of logical router port to be used for next hop
-
BLACKHOLE_ACTION_DISCARD= 'DISCARD'¶
- administrative_distance (
-
class
com.vmware.nsx_policy.model_client.StaticRoutes(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, network=None, next_hops=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructStatic routes configuration on Tier-0 or Tier-1.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - network (
str) – Specify network address in CIDR format. format: address-or-block-or-range - next_hops (
listofRouterNexthop) – Specify next hop routes for network.
- links (
-
class
com.vmware.nsx_policy.model_client.StaticRoutesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Static Routes
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofStaticRoutes) – Static Routes list results
- links (
-
class
com.vmware.nsx_policy.model_client.StatsConfiguration(label=None, navigation=None, sections=None, stat=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='StatsConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents configuration of a statistic for an entity. Example, number of logical switches and their admin states.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - label (
LabelorNone) – Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled. - navigation (
strorNone) – Hyperlink of the specified UI page that provides details. - sections (
listofDonutSectionorNone) – Sections - stat (
StatItemorNone) – Expression that fetches statistic. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states. If stat is not provided, then it will not be displayed. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
- label (
-
class
com.vmware.nsx_policy.model_client.StatusCount(degraded_count=None, down_count=None, status=None, up_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - degraded_count (
longorNone) – Degraded count format: int32 - down_count (
longorNone) – Down count format: int32 - status (
strorNone) –Possible values are:
StatusCount.STATUS_UPStatusCount.STATUS_DOWNStatusCount.STATUS_DEGRADEDStatusCount.STATUS_UNKNOWN
Roll-up status - up_count (
longorNone) – Up count format: int32
-
STATUS_DEGRADED= 'DEGRADED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- degraded_count (
-
class
com.vmware.nsx_policy.model_client.StringListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of all records
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofstr) – Domain list results
- links (
-
class
com.vmware.nsx_policy.model_client.StringMapEntry(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
str) – String key for the map - value (
strorNone) – String value for the map entry
- key (
-
class
com.vmware.nsx_policy.model_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
-
class
com.vmware.nsx_policy.model_client.SwitchSecuritySwitchingProfile(block_non_ip_traffic=None, bpdu_filter=None, dhcp_filter=None, rate_limits=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='SwitchSecuritySwitchingProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - block_non_ip_traffic (
boolorNone) – A flag to block all traffic except IP/(G)ARP/BPDU - bpdu_filter (
BpduFilterorNone) – BPDU filtering is enabled by default. A pre-defined list of MAC addresses are automatically excluded from BPDU filtering. - dhcp_filter (
DhcpFilterorNone) – DHCP server blocking is enabled and client blocking is disabled by default - rate_limits (
RateLimitsorNone) – Rate limiting is disabled by default - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) – - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
- block_non_ip_traffic (
-
class
com.vmware.nsx_policy.model_client.SwitchingProfileTypeIdEntry(key=None, value=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - key (
strorNone) –Possible values are:
SwitchingProfileTypeIdEntry.KEY_QOSSWITCHINGPROFILESwitchingProfileTypeIdEntry.KEY_PORTMIRRORINGSWITCHINGPROFILESwitchingProfileTypeIdEntry.KEY_IPDISCOVERYSWITCHINGPROFILESwitchingProfileTypeIdEntry.KEY_SPOOFGUARDSWITCHINGPROFILESwitchingProfileTypeIdEntry.KEY_SWITCHSECURITYSWITCHINGPROFILESupported switching profiles.
- value (
str) – key value
-
KEY_IPDISCOVERYSWITCHINGPROFILE= 'IpDiscoverySwitchingProfile'¶
-
KEY_MACMANAGEMENTSWITCHINGPROFILE= 'MacManagementSwitchingProfile'¶
-
KEY_PORTMIRRORINGSWITCHINGPROFILE= 'PortMirroringSwitchingProfile'¶
-
KEY_QOSSWITCHINGPROFILE= 'QosSwitchingProfile'¶
-
KEY_SPOOFGUARDSWITCHINGPROFILE= 'SpoofGuardSwitchingProfile'¶
-
KEY_SWITCHSECURITYSWITCHINGPROFILE= 'SwitchSecuritySwitchingProfile'¶
- key (
-
class
com.vmware.nsx_policy.model_client.SwitchingProfilesListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSwitching Profile queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – Switching Profile Results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inBaseSwitchingProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inBaseSwitchingProfile. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.Tag(scope=None, tag=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructArbitrary key-value pairs that may be attached to an entity
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - scope (
strorNone) – Tag searches may optionally be restricted by scope - tag (
strorNone) – Identifier meaningful to user
- scope (
-
class
com.vmware.nsx_policy.model_client.TargetResourceStatus(target_id=None, target_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHolds status of target resource in firewall context.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - target_id (
strorNone) – Identifier of the NSX resource. - target_status (
str) –Possible values are:
Firewall status on a target logical resource.
-
TARGET_STATUS_DISABLED= 'DISABLED'¶
-
TARGET_STATUS_ENABLED= 'ENABLED'¶
- target_id (
-
class
com.vmware.nsx_policy.model_client.TaskListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTask query results
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTaskProperties) – Task property results
- links (
-
class
com.vmware.nsx_policy.model_client.TaskProperties(links=None, schema=None, self_=None, async_response_available=None, cancelable=None, description=None, end_time=None, id=None, message=None, progress=None, request_method=None, request_uri=None, start_time=None, status=None, user=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTask properties
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - async_response_available (
boolorNone) – True if response for asynchronous request is available This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - cancelable (
boolorNone) – True if this task can be canceled This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of the task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - end_time (
longorNone) – The end time of the task in epoch milliseconds format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - id (
strorNone) – Identifier for this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - message (
strorNone) – A message describing the disposition of the task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - progress (
longorNone) – Task progress if known, from 0 to 100 format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - request_method (
strorNone) – HTTP request method This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - request_uri (
strorNone) – URI of the method invocation that spawned this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - start_time (
longorNone) – The start time of the task in epoch milliseconds format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
strorNone) –Possible values are:
TaskProperties.STATUS_RUNNINGTaskProperties.STATUS_ERRORTaskProperties.STATUS_SUCCESSTaskProperties.STATUS_CANCELINGTaskProperties.STATUS_CANCELEDTaskProperties.STATUS_KILLED
Current status of the taskThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- user (
strorNone) – Name of the user who created this task This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
STATUS_CANCELED= 'canceled'¶
-
STATUS_CANCELING= 'canceling'¶
-
STATUS_ERROR= 'error'¶
-
STATUS_KILLED= 'killed'¶
-
STATUS_RUNNING= 'running'¶
-
STATUS_SUCCESS= 'success'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TeamingPolicy(active_list=None, policy=None, standby_list=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructUplink Teaming Policy
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: -
POLICY_FAILOVER_ORDER= 'FAILOVER_ORDER'¶
-
POLICY_LOADBALANCE_SRCID= 'LOADBALANCE_SRCID'¶
-
-
class
com.vmware.nsx_policy.model_client.TelemetryAgreement(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, telemetry_agreement_displayed=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - telemetry_agreement_displayed (
bool) – Determine if telemetry agreement has been displayed. If false, the agreement text will be displayed at login time.
- links (
-
class
com.vmware.nsx_policy.model_client.TelemetryConfig(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ceip_acceptance=None, proxy_enabled=None, schedule_enabled=None, telemetry_proxy=None, telemetry_schedule=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ceip_acceptance (
bool) – Enable this flag to participate in the Customer Experience Improvement Program. - proxy_enabled (
boolorNone) – Enable this flag to specify a proxy, and provide the proxy settings. - schedule_enabled (
bool) – Enable this to schedule data collection and upload times. If enabled, and a schedule is not provided, a default schedule (WEEKLY, Sunday at 2:00 a.m) will be applied. - telemetry_proxy (
TelemetryProxyorNone) – Specify the proxy configuration (scheme, server, port) here. - telemetry_schedule (
vmware.vapi.struct.VapiStructorNone) – Specify one of Daily, Weekly or Monthly schedules. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inTelemetrySchedule. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inTelemetrySchedule.
- links (
-
class
com.vmware.nsx_policy.model_client.TelemetryProxy(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, hostname=None, password=None, port=None, scheme=None, username=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - hostname (
str) – Specify the fully qualified domain name, or ip address, of the proxy server. format: hostname-or-ip - password (
strorNone) – Specify the password used to authenticate with the proxy server, if required. A GET call on /telemetry/config returns a non-meaningful password to maintain security. To change the password to a new value, issue a PUT call after updating this field. To remove the password, issue a PUT call after emptying this field. To retain a previously set password, issue a PUT call keeping the non-meaningful value obtained from the GET call. - port (
long) – Specify the port of the proxy server. format: int32 - scheme (
str) –Possible values are:
The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.
- username (
strorNone) – Specify the user name used to authenticate with the proxy server, if required.
-
SCHEME_HTTP= 'HTTP'¶
-
SCHEME_HTTPS= 'HTTPS'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TelemetrySchedule(frequency_type='TelemetrySchedule')¶ Bases:
vmware.vapi.bindings.struct.VapiStructAbstract base type for telemetry schedule configuration
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: frequency_type ( str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.
-
class
com.vmware.nsx_policy.model_client.Tier0(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, force_whitelisting=None, ha_mode=None, transit_subnets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTier-0 configuration for external connectivity.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - default_rule_logging (
boolorNone) – Indicates if logging should be enabled for the default whitelisting rule. - force_whitelisting (
boolorNone) – Flag to add whitelisting FW rule during realization - ha_mode (
strorNone) –Possible values are:
Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE.
- transit_subnets (
listofstrorNone) – Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. format: ip-cidr-block
-
HA_MODE_ACTIVE= 'ACTIVE_ACTIVE'¶
-
HA_MODE_STANDBY= 'ACTIVE_STANDBY'¶
- links (
-
class
com.vmware.nsx_policy.model_client.Tier0DeploymentMap(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, enforcement_point=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAssociate tier-0 to the enforcement point to realize policy intent
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - enforcement_point (
str) – Path of enforcement point on which Tier-0 will be deployed
- links (
-
class
com.vmware.nsx_policy.model_client.Tier0DeploymentMapListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged Collection of Tier-0 Deployment map
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTier0DeploymentMap) – Tier-0 Deployment Maps
- links (
-
class
com.vmware.nsx_policy.model_client.Tier0Interface(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, subnets=None, edge_cluster_member_index=None, ls_id=None, mtu=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTier-0 interface configuration for external connectivity.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subnets (
listofInterfaceSubnet) – Specify IP address and network prefix for interface. - edge_cluster_member_index (
longorNone) – Specify association of interface with edge cluster member. format: int32 - ls_id (
str) – Specify logical switch to which tier-0 interface is connected for external access. - mtu (
longorNone) – Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. format: int32
- links (
-
class
com.vmware.nsx_policy.model_client.Tier0InterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Tier-0 Interfaces
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTier0Interface) – Tier-0 Interface list results
- links (
-
class
com.vmware.nsx_policy.model_client.Tier0ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Tier-0s
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTier0) – Tier-0 list results
- links (
-
class
com.vmware.nsx_policy.model_client.Tier1(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, default_rule_logging=None, force_whitelisting=None, tier0_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTier-1 instance configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - default_rule_logging (
boolorNone) – Indicates if logging should be enabled for the default whitelisting rule. - force_whitelisting (
boolorNone) – Flag to add whitelisting FW rule during realization - tier0_path (
strorNone) – Specify tier-1 connectivity to Tier-0 instance.
- links (
-
class
com.vmware.nsx_policy.model_client.Tier1ListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPaged collection of Tier-1 instances
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTier1) – Tier-1 list results
- links (
-
class
com.vmware.nsx_policy.model_client.TlsCertificate(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, details=None, pem_encoded=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - details (
listofX509CertificateorNone) – list of X509Certificates This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - pem_encoded (
str) – pem encoded certificate data
- links (
-
class
com.vmware.nsx_policy.model_client.TlsCertificateList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCertificate queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTlsCertificateorNone) – TlsCertificate list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TlsTrustData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - key_algo (
strorNone) – Key algorithm contained in this certificate - passphrase (
strorNone) – Password for private key encryption - pem_encoded (
str) – pem encoded certificate data - private_key (
strorNone) – private key data
- links (
-
class
com.vmware.nsx_policy.model_client.Tooltip(condition=None, text=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTooltip to be shown while hovering over the dashboard UI element.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - condition (
strorNone) – If the condition is met then the tooltip will be applied. If no condition is provided, then the tooltip will be applied unconditionally. Examples of expression syntax are provided under ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - text (
str) – Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.
- condition (
-
class
com.vmware.nsx_policy.model_client.Topology(connections=None, elements=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTopology contains the discovered/realized data for a discovery session that can be represented in graphical view. It contains two parts: - Elements: Elements are verticies that represent a policy group which contains list of VMs and processes inside VM. - Connections: Connections are edges which provides information of connectivity between the elements.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - connections (
ConnectionsorNone) – Contains list of connections that provides the information to connect the elements. Based on the view option specified in ViewTypeQueryParameter, connections contains either VM, process, group or network connection information. - elements (
listofElementorNone) – Contains list of elments of type VMElement, ProcessElement, GroupElement, LogicalSwitchElement, LogicalT0RouterElement and LogicalT1RouterElement. These elements form the nodes/verticies when preseneted in graphical view.
- connections (
-
class
com.vmware.nsx_policy.model_client.Traceflow(links=None, schema=None, self_=None, analysis=None, counters=None, id=None, logical_counters=None, lport_id=None, operation_state=None, request_status=None, result_overflowed=None, timeout=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - analysis (
listofstrorNone) – Traceflow result analysis notes This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - counters (
TraceflowObservationCountersorNone) – observation counters - id (
strorNone) – The id of the traceflow round This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_counters (
TraceflowObservationCountersorNone) – counters of observations from logical components - lport_id (
strorNone) – id of the source logical port used for injecting the traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - operation_state (
strorNone) –Possible values are:
Traceflow.OPERATION_STATE_IN_PROGRESSTraceflow.OPERATION_STATE_FINISHEDTraceflow.OPERATION_STATE_FAILED
Represents the traceflow operation stateThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- request_status (
strorNone) –Possible values are:
Traceflow.REQUEST_STATUS_SUCCESSTraceflow.REQUEST_STATUS_TIMEOUTTraceflow.REQUEST_STATUS_SOURCE_PORT_NOT_FOUNDTraceflow.REQUEST_STATUS_DATA_PATH_NOT_READYTraceflow.REQUEST_STATUS_CONNECTION_ERROR
The status of the traceflow RPC request. SUCCESS - The traceflow request is sent successfully. TIMEOUT - The traceflow request gets timeout. SOURCE_PORT_NOT_FOUND - The source port of the request is not found. DATA_PATH_NOT_READY - The datapath component is not ready to receive request. CONNECTION_ERROR - There is connection error on datapath component. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- result_overflowed (
boolorNone) – A flag, when set true, indicates some observations were deleted from the result set. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timeout (
longorNone) – Maximum time (in ms) the management plane will be waiting for this traceflow round. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
OPERATION_STATE_FAILED= 'FAILED'¶
-
OPERATION_STATE_FINISHED= 'FINISHED'¶
-
OPERATION_STATE_IN_PROGRESS= 'IN_PROGRESS'¶
-
REQUEST_STATUS_CONNECTION_ERROR= 'CONNECTION_ERROR'¶
-
REQUEST_STATUS_DATA_PATH_NOT_READY= 'DATA_PATH_NOT_READY'¶
-
REQUEST_STATUS_SOURCE_PORT_NOT_FOUND= 'SOURCE_PORT_NOT_FOUND'¶
-
REQUEST_STATUS_SUCCESS= 'SUCCESS'¶
-
REQUEST_STATUS_TIMEOUT= 'TIMEOUT'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TraceflowListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTraceflow queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTracefloworNone) – Traceflow Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservation(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservation.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservation.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservation.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservation.COMPONENT_SUB_TYPE_LS_TRANSITTraceflowObservation.COMPONENT_SUB_TYPE_UNKNOWN
The sub type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservation.COMPONENT_TYPE_PHYSICALTraceflowObservation.COMPONENT_TYPE_LRTraceflowObservation.COMPONENT_TYPE_LSTraceflowObservation.COMPONENT_TYPE_DFWTraceflowObservation.COMPONENT_TYPE_BRIDGETraceflowObservation.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservation.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservation.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservation.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservation.TRANSPORT_NODE_TYPE_ESXTraceflowObservation.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservation.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservation.TRANSPORT_NODE_TYPE_EDGETraceflowObservation.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservation.TRANSPORT_NODE_TYPE_OTHERSTraceflowObservation.TRANSPORT_NODE_TYPE_HYPERV
type of the transport node that observed a traceflow packetThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationCounters(delivered_count=None, dropped_count=None, forwarded_count=None, received_count=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - delivered_count (
longorNone) – Total number of delivered observations for this traceflow round. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dropped_count (
longorNone) – Total number of dropped observations for this round. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - forwarded_count (
longorNone) – Total number of forwarded observations for this traceflow round. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - received_count (
longorNone) – Total number of received observations for this traceflow round. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- delivered_count (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationDelivered(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, lport_id=None, lport_name=None, vlan_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationDelivered.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationDelivered.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationDelivered.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationDelivered.COMPONENT_SUB_TYPE_LS_TRANSITTraceflowObservationDelivered.COMPONENT_SUB_TYPE_UNKNOWN
The sub type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationDelivered.COMPONENT_TYPE_PHYSICALTraceflowObservationDelivered.COMPONENT_TYPE_LRTraceflowObservationDelivered.COMPONENT_TYPE_LSTraceflowObservationDelivered.COMPONENT_TYPE_DFWTraceflowObservationDelivered.COMPONENT_TYPE_BRIDGETraceflowObservationDelivered.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationDelivered.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationDelivered.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationDelivered.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationDelivered.TRANSPORT_NODE_TYPE_ESXTraceflowObservationDelivered.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationDelivered.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationDelivered.TRANSPORT_NODE_TYPE_EDGETraceflowObservationDelivered.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationDelivered.TRANSPORT_NODE_TYPE_OTHERSTraceflowObservationDelivered.TRANSPORT_NODE_TYPE_HYPERV
type of the transport node that observed a traceflow packetThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- lport_id (
strorNone) – The id of the logical port into which the traceflow packet was delivered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_name (
strorNone) – The name of the logical port into which the traceflow packet was delivered This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vlan_id (
longorNone) – VLAN on bridged network format: int64
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationDropped(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, lport_id=None, lport_name=None, reason=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationDropped.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationDropped.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationDropped.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationDropped.COMPONENT_SUB_TYPE_LS_TRANSITTraceflowObservationDropped.COMPONENT_SUB_TYPE_UNKNOWN
The sub type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationDropped.COMPONENT_TYPE_PHYSICALTraceflowObservationDropped.COMPONENT_TYPE_LRTraceflowObservationDropped.COMPONENT_TYPE_LSTraceflowObservationDropped.COMPONENT_TYPE_DFWTraceflowObservationDropped.COMPONENT_TYPE_BRIDGETraceflowObservationDropped.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationDropped.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationDropped.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationDropped.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationDropped.TRANSPORT_NODE_TYPE_ESXTraceflowObservationDropped.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationDropped.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationDropped.TRANSPORT_NODE_TYPE_EDGETraceflowObservationDropped.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationDropped.TRANSPORT_NODE_TYPE_OTHERSTraceflowObservationDropped.TRANSPORT_NODE_TYPE_HYPERV
type of the transport node that observed a traceflow packetThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- acl_rule_id (
longorNone) – The id of the acl rule that was applied to drop the traceflow packet format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_id (
strorNone) – The id of the logical port at which the traceflow packet was dropped This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_name (
strorNone) – The name of the logical port at which the traceflow packet was dropped This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - reason (
strorNone) –Possible values are:
TraceflowObservationDropped.REASON_ARP_FAILTraceflowObservationDropped.REASON_BFDTraceflowObservationDropped.REASON_DHCPTraceflowObservationDropped.REASON_FW_RULETraceflowObservationDropped.REASON_GENEVETraceflowObservationDropped.REASON_GRETraceflowObservationDropped.REASON_IFACETraceflowObservationDropped.REASON_IPTraceflowObservationDropped.REASON_IP_REASSTraceflowObservationDropped.REASON_IPSECTraceflowObservationDropped.REASON_IPSEC_VTITraceflowObservationDropped.REASON_L2VPNTraceflowObservationDropped.REASON_L4PORTTraceflowObservationDropped.REASON_LBTraceflowObservationDropped.REASON_LROUTERTraceflowObservationDropped.REASON_LSERVICETraceflowObservationDropped.REASON_LSWITCHTraceflowObservationDropped.REASON_MD_PROXYTraceflowObservationDropped.REASON_NATTraceflowObservationDropped.REASON_NEIGHTraceflowObservationDropped.REASON_NO_ROUTETraceflowObservationDropped.REASON_SERVICE_INSERTTraceflowObservationDropped.REASON_TTL_ZEROTraceflowObservationDropped.REASON_TUNNELTraceflowObservationDropped.REASON_VXLANTraceflowObservationDropped.REASON_VXSTTTraceflowObservationDropped.REASON_UNKNOWN
The reason traceflow packet was droppedThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
REASON_ARP_FAIL= 'ARP_FAIL'¶
-
REASON_BFD= 'BFD'¶
-
REASON_DHCP= 'DHCP'¶
-
REASON_FW_RULE= 'FW_RULE'¶
-
REASON_GENEVE= 'GENEVE'¶
-
REASON_GRE= 'GRE'¶
-
REASON_IFACE= 'IFACE'¶
-
REASON_IP= 'IP'¶
-
REASON_IPSEC= 'IPSEC'¶
-
REASON_IPSEC_VTI= 'IPSEC_VTI'¶
-
REASON_IP_REASS= 'IP_REASS'¶
-
REASON_L2VPN= 'L2VPN'¶
-
REASON_L4PORT= 'L4PORT'¶
-
REASON_LB= 'LB'¶
-
REASON_LROUTER= 'LROUTER'¶
-
REASON_LSERVICE= 'LSERVICE'¶
-
REASON_LSWITCH= 'LSWITCH'¶
-
REASON_MD_PROXY= 'MD_PROXY'¶
-
REASON_NAT= 'NAT'¶
-
REASON_NEIGH= 'NEIGH'¶
-
REASON_NO_ROUTE= 'NO_ROUTE'¶
-
REASON_SERVICE_INSERT= 'SERVICE_INSERT'¶
-
REASON_TTL_ZERO= 'TTL_ZERO'¶
-
REASON_TUNNEL= 'TUNNEL'¶
-
REASON_UNKNOWN= 'UNKNOWN'¶
-
REASON_VXLAN= 'VXLAN'¶
-
REASON_VXSTT= 'VXSTT'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationDroppedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, lport_id=None, lport_name=None, reason=None, component_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationDroppedLogical.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationDroppedLogical.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationDroppedLogical.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationDroppedLogical.COMPONENT_SUB_TYPE_LS_TRANSITThe sub type of the component that issued the observation.
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationDroppedLogical.COMPONENT_TYPE_PHYSICALTraceflowObservationDroppedLogical.COMPONENT_TYPE_LRTraceflowObservationDroppedLogical.COMPONENT_TYPE_LSTraceflowObservationDroppedLogical.COMPONENT_TYPE_DFWTraceflowObservationDroppedLogical.COMPONENT_TYPE_BRIDGETraceflowObservationDroppedLogical.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationDroppedLogical.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationDroppedLogical.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationDroppedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_ESXTraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_EDGETraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationDroppedLogical.TRANSPORT_NODE_TYPE_OTHERStype of the transport node that observed a traceflow packet
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- acl_rule_id (
longorNone) – The id of the acl rule that was applied to drop the traceflow packet format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_id (
strorNone) – The id of the logical port at which the traceflow packet was dropped This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_name (
strorNone) – The name of the logical port at which the traceflow packet was dropped This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - reason (
strorNone) –Possible values are:
TraceflowObservationDroppedLogical.REASON_ARP_FAILTraceflowObservationDroppedLogical.REASON_BFDTraceflowObservationDroppedLogical.REASON_DHCPTraceflowObservationDroppedLogical.REASON_FW_RULETraceflowObservationDroppedLogical.REASON_GENEVETraceflowObservationDroppedLogical.REASON_GRETraceflowObservationDroppedLogical.REASON_IFACETraceflowObservationDroppedLogical.REASON_IPTraceflowObservationDroppedLogical.REASON_IP_REASSTraceflowObservationDroppedLogical.REASON_IPSECTraceflowObservationDroppedLogical.REASON_IPSEC_VTITraceflowObservationDroppedLogical.REASON_L2VPNTraceflowObservationDroppedLogical.REASON_L4PORTTraceflowObservationDroppedLogical.REASON_LBTraceflowObservationDroppedLogical.REASON_LROUTERTraceflowObservationDroppedLogical.REASON_LSERVICETraceflowObservationDroppedLogical.REASON_LSWITCHTraceflowObservationDroppedLogical.REASON_MD_PROXYTraceflowObservationDroppedLogical.REASON_NATTraceflowObservationDroppedLogical.REASON_NEIGHTraceflowObservationDroppedLogical.REASON_NO_ROUTETraceflowObservationDroppedLogical.REASON_SERVICE_INSERTTraceflowObservationDroppedLogical.REASON_TTL_ZEROTraceflowObservationDroppedLogical.REASON_TUNNELTraceflowObservationDroppedLogical.REASON_VXLANTraceflowObservationDroppedLogical.REASON_VXSTTTraceflowObservationDroppedLogical.REASON_UNKNOWN
The reason traceflow packet was droppedThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_id (
strorNone) – The id of the component that dropped the traceflow packet. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
REASON_ARP_FAIL= 'ARP_FAIL'¶
-
REASON_BFD= 'BFD'¶
-
REASON_DHCP= 'DHCP'¶
-
REASON_FW_RULE= 'FW_RULE'¶
-
REASON_GENEVE= 'GENEVE'¶
-
REASON_GRE= 'GRE'¶
-
REASON_IFACE= 'IFACE'¶
-
REASON_IP= 'IP'¶
-
REASON_IPSEC= 'IPSEC'¶
-
REASON_IPSEC_VTI= 'IPSEC_VTI'¶
-
REASON_IP_REASS= 'IP_REASS'¶
-
REASON_L2VPN= 'L2VPN'¶
-
REASON_L4PORT= 'L4PORT'¶
-
REASON_LB= 'LB'¶
-
REASON_LROUTER= 'LROUTER'¶
-
REASON_LSERVICE= 'LSERVICE'¶
-
REASON_LSWITCH= 'LSWITCH'¶
-
REASON_MD_PROXY= 'MD_PROXY'¶
-
REASON_NAT= 'NAT'¶
-
REASON_NEIGH= 'NEIGH'¶
-
REASON_NO_ROUTE= 'NO_ROUTE'¶
-
REASON_SERVICE_INSERT= 'SERVICE_INSERT'¶
-
REASON_TTL_ZERO= 'TTL_ZERO'¶
-
REASON_TUNNEL= 'TUNNEL'¶
-
REASON_UNKNOWN= 'UNKNOWN'¶
-
REASON_VXLAN= 'VXLAN'¶
-
REASON_VXSTT= 'VXSTT'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationForwarded(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, context=None, dst_transport_node_id=None, dst_transport_node_name=None, local_ip_address=None, remote_ip_address=None, uplink_name=None, vtep_label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationForwarded.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationForwarded.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationForwarded.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationForwarded.COMPONENT_SUB_TYPE_LS_TRANSITTraceflowObservationForwarded.COMPONENT_SUB_TYPE_UNKNOWN
The sub type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationForwarded.COMPONENT_TYPE_PHYSICALTraceflowObservationForwarded.COMPONENT_TYPE_LRTraceflowObservationForwarded.COMPONENT_TYPE_LSTraceflowObservationForwarded.COMPONENT_TYPE_DFWTraceflowObservationForwarded.COMPONENT_TYPE_BRIDGETraceflowObservationForwarded.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationForwarded.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationForwarded.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationForwarded.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationForwarded.TRANSPORT_NODE_TYPE_ESXTraceflowObservationForwarded.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationForwarded.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationForwarded.TRANSPORT_NODE_TYPE_EDGETraceflowObservationForwarded.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationForwarded.TRANSPORT_NODE_TYPE_OTHERSTraceflowObservationForwarded.TRANSPORT_NODE_TYPE_HYPERV
type of the transport node that observed a traceflow packetThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- context (
longorNone) – The 64bit tunnel context carried on the wire. format: int64 - dst_transport_node_id (
strorNone) – This field will not be always available. Use remote_ip_address when this field is not set. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dst_transport_node_name (
strorNone) – The name of the transport node to which the traceflow packet is forwarded This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_ip_address (
strorNone) – IP address of the source end of the tunnel format: ip - remote_ip_address (
strorNone) – IP address of the destination end of the tunnel format: ip - uplink_name (
strorNone) – The name of the uplink the traceflow packet is forwarded on - vtep_label (
longorNone) – The virtual tunnel endpoint label format: int64
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationForwardedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, acl_rule_id=None, component_id=None, dst_component_id=None, dst_component_name=None, dst_component_type=None, lport_id=None, lport_name=None, vni=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationForwardedLogical.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationForwardedLogical.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationForwardedLogical.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationForwardedLogical.COMPONENT_SUB_TYPE_LS_TRANSITThe sub type of the component that issued the observation.
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationForwardedLogical.COMPONENT_TYPE_PHYSICALTraceflowObservationForwardedLogical.COMPONENT_TYPE_LRTraceflowObservationForwardedLogical.COMPONENT_TYPE_LSTraceflowObservationForwardedLogical.COMPONENT_TYPE_DFWTraceflowObservationForwardedLogical.COMPONENT_TYPE_BRIDGETraceflowObservationForwardedLogical.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationForwardedLogical.COMPONENT_TYPE_EDGE_HOSTSWITCHThe type of the component that issued the observation.
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationForwardedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_ESXTraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_EDGETraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationForwardedLogical.TRANSPORT_NODE_TYPE_OTHERStype of the transport node that observed a traceflow packet
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- acl_rule_id (
longorNone) – The id of the acl rule that was applied to forward the traceflow packet format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_id (
strorNone) – The id of the component that forwarded the traceflow packet. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dst_component_id (
strorNone) – The id of the destination component to which the traceflow packet was forwarded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dst_component_name (
strorNone) – The name of the destination component to which the traceflow packet was forwarded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dst_component_type (
strorNone) –Possible values are:
TraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_PHYSICALTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_LRTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_LSTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_DFWTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_BRIDGETraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationForwardedLogical.DST_COMPONENT_TYPE_UNKNOWN
The type of the destination component to which the traceflow packet was forwarded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- lport_id (
strorNone) – The id of the logical port through which the traceflow packet was forwarded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_name (
strorNone) – The name of the logical port through which the traceflow packet was forwarded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vni (
longorNone) – VNI for the logical network on which the traceflow packet was forwarded. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
DST_COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
DST_COMPONENT_TYPE_DFW= 'DFW'¶
-
DST_COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
DST_COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
DST_COMPONENT_TYPE_LR= 'LR'¶
-
DST_COMPONENT_TYPE_LS= 'LS'¶
-
DST_COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
DST_COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTraceflowObservationorNone) – TraceflowObservation list results
- links (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationReceived(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, local_ip_address=None, remote_ip_address=None, uplink_name=None, vtep_label=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationReceived.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationReceived.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationReceived.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationReceived.COMPONENT_SUB_TYPE_LS_TRANSITTraceflowObservationReceived.COMPONENT_SUB_TYPE_UNKNOWN
The sub type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationReceived.COMPONENT_TYPE_PHYSICALTraceflowObservationReceived.COMPONENT_TYPE_LRTraceflowObservationReceived.COMPONENT_TYPE_LSTraceflowObservationReceived.COMPONENT_TYPE_DFWTraceflowObservationReceived.COMPONENT_TYPE_BRIDGETraceflowObservationReceived.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationReceived.COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationReceived.COMPONENT_TYPE_UNKNOWN
The type of the component that issued the observation.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationReceived.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationReceived.TRANSPORT_NODE_TYPE_ESXTraceflowObservationReceived.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationReceived.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationReceived.TRANSPORT_NODE_TYPE_EDGETraceflowObservationReceived.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationReceived.TRANSPORT_NODE_TYPE_OTHERSTraceflowObservationReceived.TRANSPORT_NODE_TYPE_HYPERV
type of the transport node that observed a traceflow packetThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- local_ip_address (
strorNone) – IP address of the destination end of the tunnel format: ip - remote_ip_address (
strorNone) – IP address of the source end of the tunnel format: ip - uplink_name (
strorNone) – The name of the uplink the traceflow packet is received on - vtep_label (
longorNone) – The virtual tunnel endpoint label format: int64
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TraceflowObservationReceivedLogical(component_name=None, component_sub_type=None, component_type=None, resource_type=None, sequence_no=None, timestamp=None, timestamp_micro=None, transport_node_id=None, transport_node_name=None, transport_node_type=None, component_id=None, lport_id=None, lport_name=None, src_component_id=None, src_component_name=None, src_component_type=None, vni=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - component_name (
strorNone) – The name of the component that issued the observation. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - component_sub_type (
strorNone) –Possible values are:
TraceflowObservationReceivedLogical.COMPONENT_SUB_TYPE_LR_TIER0TraceflowObservationReceivedLogical.COMPONENT_SUB_TYPE_LR_TIER1TraceflowObservationReceivedLogical.COMPONENT_SUB_TYPE_LR_VRF_TIER0TraceflowObservationReceivedLogical.COMPONENT_SUB_TYPE_LS_TRANSITThe sub type of the component that issued the observation.
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_type (
strorNone) –Possible values are:
TraceflowObservationReceivedLogical.COMPONENT_TYPE_PHYSICALTraceflowObservationReceivedLogical.COMPONENT_TYPE_LRTraceflowObservationReceivedLogical.COMPONENT_TYPE_LSTraceflowObservationReceivedLogical.COMPONENT_TYPE_DFWTraceflowObservationReceivedLogical.COMPONENT_TYPE_BRIDGETraceflowObservationReceivedLogical.COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationReceivedLogical.COMPONENT_TYPE_EDGE_HOSTSWITCHThe type of the component that issued the observation.
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- resource_type (
str) –Possible values are:
TraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVEREDTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICALTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICALTraceflowObservationReceivedLogical.RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL
- sequence_no (
longorNone) – the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp (
longorNone) – Timestamp when the observation was created by the transport node (milliseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - timestamp_micro (
longorNone) – Timestamp when the observation was created by the transport node (microseconds epoch) format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_id (
strorNone) – id of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_name (
strorNone) – name of the transport node that observed a traceflow packet This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_node_type (
strorNone) –Possible values are:
TraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_ESXTraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_RHELKVMTraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_UBUNTUKVMTraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_EDGETraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODETraceflowObservationReceivedLogical.TRANSPORT_NODE_TYPE_OTHERStype of the transport node that observed a traceflow packet
This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- component_id (
strorNone) – The id of the component that received the traceflow packet. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_id (
strorNone) – The id of the logical port at which the traceflow packet was received This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - lport_name (
strorNone) – The name of the logical port at which the traceflow packet was received This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_component_id (
strorNone) – The id of the source component from which the traceflow packet was received. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_component_name (
strorNone) – The name of source component from which the traceflow packet was received. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_component_type (
strorNone) –Possible values are:
TraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_PHYSICALTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_LRTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_LSTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_DFWTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_BRIDGETraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_EDGE_TUNNELTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_EDGE_HOSTSWITCHTraceflowObservationReceivedLogical.SRC_COMPONENT_TYPE_UNKNOWN
The type of the source component from which the traceflow packet was received. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- vni (
longorNone) – VNI for the logical network on which the traceflow packet was received. format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
COMPONENT_SUB_TYPE_LR_TIER0= 'LR_TIER0'¶
-
COMPONENT_SUB_TYPE_LR_TIER1= 'LR_TIER1'¶
-
COMPONENT_SUB_TYPE_LR_VRF_TIER0= 'LR_VRF_TIER0'¶
-
COMPONENT_SUB_TYPE_LS_TRANSIT= 'LS_TRANSIT'¶
-
COMPONENT_SUB_TYPE_UNKNOWN= 'UNKNOWN'¶
-
COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
COMPONENT_TYPE_DFW= 'DFW'¶
-
COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
COMPONENT_TYPE_LR= 'LR'¶
-
COMPONENT_TYPE_LS= 'LS'¶
-
COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDELIVERED= 'TraceflowObservationDelivered'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPED= 'TraceflowObservationDropped'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONDROPPEDLOGICAL= 'TraceflowObservationDroppedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDED= 'TraceflowObservationForwarded'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONFORWARDEDLOGICAL= 'TraceflowObservationForwardedLogical'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVED= 'TraceflowObservationReceived'¶
-
RESOURCE_TYPE_TRACEFLOWOBSERVATIONRECEIVEDLOGICAL= 'TraceflowObservationReceivedLogical'¶
-
SRC_COMPONENT_TYPE_BRIDGE= 'BRIDGE'¶
-
SRC_COMPONENT_TYPE_DFW= 'DFW'¶
-
SRC_COMPONENT_TYPE_EDGE_HOSTSWITCH= 'EDGE_HOSTSWITCH'¶
-
SRC_COMPONENT_TYPE_EDGE_TUNNEL= 'EDGE_TUNNEL'¶
-
SRC_COMPONENT_TYPE_LR= 'LR'¶
-
SRC_COMPONENT_TYPE_LS= 'LS'¶
-
SRC_COMPONENT_TYPE_PHYSICAL= 'PHYSICAL'¶
-
SRC_COMPONENT_TYPE_UNKNOWN= 'UNKNOWN'¶
-
TRANSPORT_NODE_TYPE_EDGE= 'EDGE'¶
-
TRANSPORT_NODE_TYPE_ESX= 'ESX'¶
-
TRANSPORT_NODE_TYPE_HYPERV= 'HYPERV'¶
-
TRANSPORT_NODE_TYPE_OTHERS= 'OTHERS'¶
-
TRANSPORT_NODE_TYPE_PUBLIC_CLOUD_GATEWAY_NODE= 'PUBLIC_CLOUD_GATEWAY_NODE'¶
-
TRANSPORT_NODE_TYPE_RHELKVM= 'RHELKVM'¶
-
TRANSPORT_NODE_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
- component_name (
-
class
com.vmware.nsx_policy.model_client.TransportNode(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_spec=None, host_switches=None, maintenance_mode=None, node_id=None, transport_zone_endpoints=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport Node
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - host_switch_spec (
vmware.vapi.struct.VapiStructorNone) – This property is used to either create standard host switches or to inform NSX about preconfigured host switches that already exist on the transport node. Pass an array of either StandardHostSwitchSpec objects or PreconfiguredHostSwitchSpec objects. It is an error to pass an array containing different types of HostSwitchSpec objects. When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inHostSwitchSpec. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inHostSwitchSpec. - host_switches (
listofHostSwitchorNone) – This property is deprecated in favor of ‘host_switch_spec’. Property ‘host_switches’ can only be used for NSX managed transport nodes. ‘host_switch_spec’ can be used for both NSX managed or manually preconfigured host switches. - maintenance_mode (
strorNone) –Possible values are:
TransportNode.MAINTENANCE_MODE_ENABLEDTransportNode.MAINTENANCE_MODE_FORCE_ENABLEDTransportNode.MAINTENANCE_MODE_DISABLED
The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- node_id (
str) – Unique Id of the fabric node - transport_zone_endpoints (
listofTransportZoneEndPointorNone) – Transport zone endpoints.
-
MAINTENANCE_MODE_DISABLED= 'DISABLED'¶
-
MAINTENANCE_MODE_ENABLED= 'ENABLED'¶
-
MAINTENANCE_MODE_FORCE_ENABLED= 'FORCE_ENABLED'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TransportNodeListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport Node queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTransportNodeorNone) – TransportNode Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TransportNodeState(details=None, failure_code=None, failure_message=None, state=None, host_switch_states=None, maintenance_mode_state=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport Node State
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - details (
listofConfigurationStateElementorNone) – Array of configuration state of various sub systems This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_code (
longorNone) – Error code format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - failure_message (
strorNone) – Error message in case of failure This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - state (
strorNone) –Possible values are:
TransportNodeState.STATE_PENDINGTransportNodeState.STATE_IN_PROGRESSTransportNodeState.STATE_SUCCESSTransportNodeState.STATE_FAILEDTransportNodeState.STATE_PARTIAL_SUCCESSTransportNodeState.STATE_ORPHANEDTransportNodeState.STATE_UNKNOWN
Gives details of state of desired configurationThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- host_switch_states (
listofHostSwitchStateorNone) – States of HostSwitches on the host This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - maintenance_mode_state (
strorNone) –Possible values are:
TransportNodeState.MAINTENANCE_MODE_STATE_ENTERINGTransportNodeState.MAINTENANCE_MODE_STATE_ENABLEDTransportNodeState.MAINTENANCE_MODE_STATE_EXITINGTransportNodeState.MAINTENANCE_MODE_STATE_DISABLED
the present realized maintenance mode stateThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- transport_node_id (
strorNone) – Unique Id of the TransportNode This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
MAINTENANCE_MODE_STATE_DISABLED= 'DISABLED'¶
-
MAINTENANCE_MODE_STATE_ENABLED= 'ENABLED'¶
-
MAINTENANCE_MODE_STATE_ENTERING= 'ENTERING'¶
-
MAINTENANCE_MODE_STATE_EXITING= 'EXITING'¶
-
STATE_FAILED= 'failed'¶
-
STATE_IN_PROGRESS= 'in_progress'¶
-
STATE_ORPHANED= 'orphaned'¶
-
STATE_PARTIAL_SUCCESS= 'partial_success'¶
-
STATE_PENDING= 'pending'¶
-
STATE_SUCCESS= 'success'¶
-
STATE_UNKNOWN= 'unknown'¶
- details (
-
class
com.vmware.nsx_policy.model_client.TransportNodeStateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport node state queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTransportNodeStateorNone) – Transport Node State Results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TransportNodeStatus(control_connection_status=None, mgmt_connection_status=None, node_display_name=None, node_uuid=None, pnic_status=None, status=None, tunnel_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - control_connection_status (
StatusCountorNone) – Control connection status - mgmt_connection_status (
strorNone) –Possible values are:
Management connection status - node_display_name (
strorNone) – Transport node display name - node_uuid (
strorNone) – Transport node uuid - pnic_status (
StatusCountorNone) – pNIC status - status (
strorNone) –Possible values are:
TransportNodeStatus.STATUS_UPTransportNodeStatus.STATUS_DOWNTransportNodeStatus.STATUS_DEGRADEDTransportNodeStatus.STATUS_UNKNOWN
Roll-up status of pNIC, management connection, control connection, tunnel status
- tunnel_status (
TunnelStatusCountorNone) – Tunnel Status
-
MGMT_CONNECTION_STATUS_DOWN= 'DOWN'¶
-
MGMT_CONNECTION_STATUS_UP= 'UP'¶
-
STATUS_DEGRADED= 'DEGRADED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- control_connection_status (
-
class
com.vmware.nsx_policy.model_client.TransportNodeStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTransportNodeStatusorNone) – List of transport node statuses
- links (
-
class
com.vmware.nsx_policy.model_client.TransportNodeTemplateListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCompute collection transport node template list result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofComputeCollectionTransportNodeTemplateorNone) – Compute collection transport node template results This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TransportNodeTemplateState(node_id=None, state=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructtransport node template application state
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - node_id (
str) – node id - state (
strorNone) –Possible values are:
TransportNodeTemplateState.STATE_FAILED_TO_CREATETransportNodeTemplateState.STATE_IN_PROGRESSTransportNodeTemplateState.STATE_FAILED_TO_REALIZETransportNodeTemplateState.STATE_SUCCESS
Transport node template state on individual hosts of ComputeCollection which enabled automated transport code creation. ‘FAILED_TO_CREATE’ means transport node isn’t created. ‘IN_PROGRESS’ means transport node is in progress of creation. ‘FAILED_TO_REALIZE’ means transport node has been created, but failed on host realization, it will repush to host by NSX later. ‘SUCCESS’ means transport node creation is succeeded. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- transport_node_id (
strorNone) – transport node id
-
STATE_FAILED_TO_CREATE= 'FAILED_TO_CREATE'¶
-
STATE_FAILED_TO_REALIZE= 'FAILED_TO_REALIZE'¶
-
STATE_IN_PROGRESS= 'IN_PROGRESS'¶
-
STATE_SUCCESS= 'SUCCESS'¶
- node_id (
-
class
com.vmware.nsx_policy.model_client.TransportZone(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, host_switch_id=None, host_switch_mode=None, host_switch_name=None, nested_nsx=None, transport_type=None, transport_zone_profile_ids=None, uplink_teaming_policy_names=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - host_switch_id (
strorNone) – the host switch id generated by the system. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - host_switch_mode (
strorNone) –Possible values are:
STANDARD mode applies to all the hypervisors. ENS mode stands for Enhanced Networking Stack. This feature is only available for ESX hypervisor. It is not available on KVM, EDGE and Public Cloud Gateway etc. When a Transport Zone mode is set to ENS, only Transport Nodes of type ESX can participate in such a Transport Zone.
- host_switch_name (
strorNone) – If this name is unset or empty then the default host switch name will be used. - nested_nsx (
boolorNone) – The flag only need to be set in nested NSX environment. - transport_type (
str) –Possible values are:
The transport type of this transport zone. - transport_zone_profile_ids (
listofTransportZoneProfileTypeIdEntryorNone) – Identifiers of the transport zone profiles associated with this TransportZone. - uplink_teaming_policy_names (
listofstrorNone) – The names of switching uplink teaming policies that all transport nodes in this transport zone must support. An exception will be thrown if a transport node within the transport zone does not support a named teaming policy. The user will need to first ensure all trasnport nodes support the desired named teaming policy before assigning it to the transport zone. If the field is not specified, the host switch’s default teaming policy will be used.
-
HOST_SWITCH_MODE_ENS= 'ENS'¶
-
HOST_SWITCH_MODE_STANDARD= 'STANDARD'¶
-
TRANSPORT_TYPE_OVERLAY= 'OVERLAY'¶
-
TRANSPORT_TYPE_VLAN= 'VLAN'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TransportZoneEndPoint(transport_zone_id=None, transport_zone_profile_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructSpecify which HostSwitch from this TransportNode is used handle traffic for given TransportZone
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - transport_zone_id (
str) – Unique ID identifying the transport zone for this endpoint - transport_zone_profile_ids (
listofTransportZoneProfileTypeIdEntryorNone) – Identifiers of the transport zone profiles associated with this transport zone endpoint on this transport node.
- transport_zone_id (
-
class
com.vmware.nsx_policy.model_client.TransportZoneListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport zone queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTransportZone) – Transport Zone Results
- links (
-
class
com.vmware.nsx_policy.model_client.TransportZoneProfile(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='TransportZoneProfile', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE= 'BfdHealthMonitoringProfile'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TransportZoneProfileListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport zone profile queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofvmware.vapi.struct.VapiStructorNone) – Transport zone profile results When clients pass a value of this class as a parameter, the attribute must contain all the attributes defined inTransportZoneProfile. When methods return a value of this class as a return value, the attribute will contain all the attributes defined inTransportZoneProfile. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TransportZoneProfileTypeIdEntry(profile_id=None, resource_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - profile_id (
str) – profile id of the resource type - resource_type (
strorNone) –Possible values are:
Selects the type of the transport zone profile
-
RESOURCE_TYPE_BFDHEALTHMONITORINGPROFILE= 'BfdHealthMonitoringProfile'¶
- profile_id (
-
class
com.vmware.nsx_policy.model_client.TransportZoneStatus(num_logical_ports=None, num_logical_switches=None, num_transport_nodes=None, transport_zone_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport zone runtime status information
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - num_logical_ports (
longorNone) – Count of logical ports in the transport zone format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - num_logical_switches (
longorNone) – Count of logical switches in the transport zone format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - num_transport_nodes (
longorNone) – Count of transport nodes in the transport zone format: int32 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_zone_id (
strorNone) – Unique ID identifying the transport zone This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- num_logical_ports (
-
class
com.vmware.nsx_policy.model_client.TransportZoneStatusListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTransport zone runtime status queries result
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofTransportZoneStatus) – Transport Zone Runtime Status Info Results
- links (
-
class
com.vmware.nsx_policy.model_client.TrunkVlanRange(end=None, start=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTrunk VLAN id range
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - end (
long) – Virtual Local Area Network Identifier format: int64 - start (
long) – Virtual Local Area Network Identifier format: int64
- end (
-
class
com.vmware.nsx_policy.model_client.TrustManagementData(supported_algorithms=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: supported_algorithms ( listofCryptoAlgorithmorNone) – list of supported algorithms This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
class
com.vmware.nsx_policy.model_client.TrustObjectData(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, key_algo=None, passphrase=None, pem_encoded=None, private_key=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - key_algo (
strorNone) – Key algorithm contained in this certificate - passphrase (
strorNone) – Password for private key encryption - pem_encoded (
str) – pem encoded certificate data - private_key (
strorNone) – private key data
- links (
-
class
com.vmware.nsx_policy.model_client.TunnelList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, tunnels=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - tunnels (
listofTunnelPropertiesorNone) – List of transport node tunnels This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.TunnelPortConfig(ip_subnets=None, tunnel_port_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructIP Tunnel port configuration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_subnets (
listofIPSubnet) – IP Tunnel port (commonly referred as VTI) subnet. - tunnel_port_id (
strorNone) – Logical route port identifier. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- ip_subnets (
-
class
com.vmware.nsx_policy.model_client.TunnelProperties(links=None, schema=None, self_=None, bfd=None, egress_interface=None, encap=None, last_updated_time=None, local_ip=None, name=None, remote_ip=None, remote_node_display_name=None, remote_node_id=None, status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - bfd (
BFDPropertiesorNone) – Detailed information about BFD configured on interface - egress_interface (
strorNone) – Corresponds to the interface where local_ip_address is routed. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - encap (
strorNone) –Possible values are:
TunnelProperties.ENCAP_STTTunnelProperties.ENCAP_VXLANTunnelProperties.ENCAP_GENEVETunnelProperties.ENCAP_UNKNOWN_ENCAP
Tunnel encapThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- last_updated_time (
longorNone) – Time at which the Tunnel status has been fetched last time. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - local_ip (
strorNone) – Local IP address of tunnel format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – Name of tunnel This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_ip (
strorNone) – Remote IP address of tunnel format: ip This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_node_display_name (
strorNone) – Represents the display name of the remote transport node at the other end of the tunnel. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - remote_node_id (
strorNone) – UUID of the remote transport node This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - status (
strorNone) –Possible values are:
Status of tunnelThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
ENCAP_GENEVE= 'GENEVE'¶
-
ENCAP_STT= 'STT'¶
-
ENCAP_UNKNOWN_ENCAP= 'UNKNOWN_ENCAP'¶
-
ENCAP_VXLAN= 'VXLAN'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- links (
-
class
com.vmware.nsx_policy.model_client.TunnelStatusCount(degraded_count=None, down_count=None, status=None, up_count=None, bfd_diagnostic=None, bfd_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - degraded_count (
longorNone) – Degraded count format: int32 - down_count (
longorNone) – Down count format: int32 - status (
strorNone) –Possible values are:
TunnelStatusCount.STATUS_UPTunnelStatusCount.STATUS_DOWNTunnelStatusCount.STATUS_DEGRADEDTunnelStatusCount.STATUS_UNKNOWN
Roll-up status - up_count (
longorNone) – Up count format: int32 - bfd_diagnostic (
BFDDiagnosticCountorNone) – BFD Diagnostic - bfd_status (
BFDStatusCountorNone) – BFD Status
-
STATUS_DEGRADED= 'DEGRADED'¶
-
STATUS_DOWN= 'DOWN'¶
-
STATUS_UNKNOWN= 'UNKNOWN'¶
-
STATUS_UP= 'UP'¶
- degraded_count (
-
class
com.vmware.nsx_policy.model_client.TunnelSubnet(ip_addresses=None, prefix_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - ip_addresses (
listofstr) – Subnet ip addresses format: ipv4 - prefix_length (
long) – Subnet Prefix Length format: int64
- ip_addresses (
-
class
com.vmware.nsx_policy.model_client.TypeGroup(count=None, group_by_field_value=None, hits=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - count (
long) – Total count per group by field value format: int64 - group_by_field_value (
str) – Group By Field Value - hits (
listofvmware.vapi.struct.VapiStructorNone) – Hits per resource type
- count (
-
class
com.vmware.nsx_policy.model_client.UnassociatedVMListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp in milliseconds since epoch format: int64 - results (
listofVirtualMachine) – List of VMs which are not associated with any NSGroup
- links (
-
class
com.vmware.nsx_policy.model_client.UpdatePrincipalIdentityCertificateRequest(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, certificate_id=None, principal_identity_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRequest to update the certificate of a principal identity with a new certificate
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - certificate_id (
str) – Id of the stored certificate - principal_identity_id (
str) – Unique ID of the principal
- links (
-
class
com.vmware.nsx_policy.model_client.UpgradeHistory(initial_version=None, target_version=None, timestamp=None, upgrade_status=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - initial_version (
str) – Version before the upgrade started - target_version (
str) – Version being upgraded to - timestamp (
long) – Timestamp (in milliseconds since epoch) when the upgrade was performed format: int64 - upgrade_status (
str) –Possible values are:
UpgradeHistory.UPGRADE_STATUS_STARTEDUpgradeHistory.UPGRADE_STATUS_SUCCESSUpgradeHistory.UPGRADE_STATUS_FAILED
Status of the upgrade
-
UPGRADE_STATUS_FAILED= 'FAILED'¶
-
UPGRADE_STATUS_STARTED= 'STARTED'¶
-
UPGRADE_STATUS_SUCCESS= 'SUCCESS'¶
- initial_version (
-
class
com.vmware.nsx_policy.model_client.UpgradeHistoryList(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofUpgradeHistoryorNone) – Upgrade history list This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.Uplink(uplink_name=None, uplink_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructObject to identify an uplink based on its type and name
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - uplink_name (
str) – Name of this uplink - uplink_type (
str) –Possible values are:
Type of the uplink
-
UPLINK_TYPE_LAG= 'LAG'¶
-
UPLINK_TYPE_PNIC= 'PNIC'¶
- uplink_name (
-
class
com.vmware.nsx_policy.model_client.UplinkHostSwitchProfile(lags=None, mtu=None, named_teamings=None, overlay_encap=None, teaming=None, transport_vlan=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='UplinkHostSwitchProfile', tags=None, required_capabilities=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructProfile for uplink policies
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - lags (
listofLagorNone) – list of LACP group - mtu (
longorNone) – Maximum Transmission Unit used for uplinks format: int32 - named_teamings (
listofNamedTeamingPolicyorNone) – List of named uplink teaming policies that can be used by logical switches - overlay_encap (
strorNone) –Possible values are:
The protocol used to encapsulate overlay traffic - teaming (
TeamingPolicy) – Default TeamingPolicy associated with this UplinkProfile - transport_vlan (
longorNone) – VLAN used for tagging Overlay traffic of associated HostSwitch format: int64 - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - required_capabilities (
listofstrorNone) –
-
OVERLAY_ENCAP_GENEVE= 'GENEVE'¶
-
OVERLAY_ENCAP_VXLAN= 'VXLAN'¶
- lags (
-
class
com.vmware.nsx_policy.model_client.UrlAlias(alias=None, query=None, url=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructShort name or alias of a url. It is used to represent the url.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - alias (
strorNone) – - query (
strorNone) – Search query to be applied, if any. If query string is not provided, it will be ignored. - url (
str) – Url to fetch data from.
- alias (
-
class
com.vmware.nsx_policy.model_client.UserInfo(roles=None, user_name=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructAuthenticated User Info
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - roles (
listofNsxRoleorNone) – Permissions This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - user_name (
strorNone) – User Name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- roles (
-
class
com.vmware.nsx_policy.model_client.UsernamePasswordLoginCredential(password=None, thumbprint=None, username=None, credential_type='UsernamePasswordLoginCredential')¶ Bases:
vmware.vapi.bindings.struct.VapiStructA login credential specifying a username and password
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - password (
strorNone) – The authentication password for login - thumbprint (
strorNone) – Thumbprint of the login server - username (
strorNone) – The username for login - credential_type (
str) – Possible values are ‘UsernamePasswordLoginCredential’, ‘VerifiableAsymmetricLoginCredential’.
- password (
-
class
com.vmware.nsx_policy.model_client.VIPSubnet(active_vip_addresses=None, prefix_length=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - active_vip_addresses (
listofstr) – Array of IP address subnets which will be used as floating IP addresses. | These IPs will move and will be owned by Active node. format: ipv4 - prefix_length (
long) – Subnet Prefix Length format: int64
- active_vip_addresses (
-
class
com.vmware.nsx_policy.model_client.VMConnection(dest_element_id=None, number_of_events=None, src_element_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVMConnection contains the statistic information of connection from source VM to destination VM.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_element_id (
strorNone) – Unique element ID of destination element to which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - number_of_events (
longorNone) – Represents the number of events/flows between the source and destination elements. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - src_element_id (
strorNone) – Unique element ID of source element from which the connection is established. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- dest_element_id (
-
class
com.vmware.nsx_policy.model_client.VMElement(element_id=None, elements=None, resource_name=None, resource_type=None, vm_bios_uuid=None, vm_external_id=None, vm_host_id=None, vm_host_name=None, vm_instance_uuid=None, vm_ips=None, vm_path=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVM element extends from Element class. This class contains the information related to a VM.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
VMElement.RESOURCE_TYPE_VMELEMENTVMElement.RESOURCE_TYPE_GROUPELEMENTVMElement.RESOURCE_TYPE_PROCESSELEMENTVMElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTVMElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTVMElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTVMElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTVMElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTVMElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTVMElement.RESOURCE_TYPE_HOSTNODEELEMENTVMElement.RESOURCE_TYPE_EDGENODEELEMENTVMElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTVMElement.RESOURCE_TYPE_LBVIRTUALSERVERELEMENT
Resource type of the element - vm_bios_uuid (
strorNone) – VM Bios Uuid This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_external_id (
strorNone) – VM external ID This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_host_id (
strorNone) – VM host ID This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_host_name (
strorNone) – VM host name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_instance_uuid (
strorNone) – VM instance Uuid This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_ips (
listofstrorNone) – List of VM IPs This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - vm_path (
strorNone) – VM path information This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.ValueConstraintExpression(operator=None, values=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='ValueConstraintExpression', tags=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents the leaf level value constraint to constrain specified attribute value to the set of values to be allowed/not-allowed. Example - sourceGroups allowed to have only with list of groups. { "operator":"INCLUDES", "values":["/infra/services/HTTP", "/infra/services/HTTPS"] }
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - operator (
str) –Possible values are:
ValueConstraintExpression.OPERATOR_INCLUDESValueConstraintExpression.OPERATOR_EXCLUDESValueConstraintExpression.OPERATOR_EQUALS
Operation to check for value list for resource attribute of constraint.
- values (
listofstr) – List of values. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user
-
OPERATOR_EQUALS= 'EQUALS'¶
-
OPERATOR_EXCLUDES= 'EXCLUDES'¶
-
OPERATOR_INCLUDES= 'INCLUDES'¶
- operator (
-
class
com.vmware.nsx_policy.model_client.VerifiableAsymmetricLoginCredential(asymmetric_credential=None, credential_key=None, credential_verifier=None, credential_type='VerifiableAsymmetricLoginCredential')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - asymmetric_credential (
strorNone) – Asymmetric login credential - credential_key (
strorNone) – Credential key - credential_verifier (
strorNone) – Credential verifier - credential_type (
str) – Possible values are ‘UsernamePasswordLoginCredential’, ‘VerifiableAsymmetricLoginCredential’.
- asymmetric_credential (
-
class
com.vmware.nsx_policy.model_client.VersionList(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, acceptable_versions=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - acceptable_versions (
listofstr) – List of component versions
- links (
-
class
com.vmware.nsx_policy.model_client.VersionedDeploymentSpec(host_type=None, host_version=None, package_stores=None, service_vm_ovf_url=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVersioned DeploymentSpec contains vibs and ofv urls for specific version of fabric module and host type and host version.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - host_type (
str) –Possible values are:
VersionedDeploymentSpec.HOST_TYPE_ESXIVersionedDeploymentSpec.HOST_TYPE_RHELKVMVersionedDeploymentSpec.HOST_TYPE_UBUNTUKVMVersionedDeploymentSpec.HOST_TYPE_RHELCONTAINERVersionedDeploymentSpec.HOST_TYPE_RHELSERVERVersionedDeploymentSpec.HOST_TYPE_UBUNTUSERVERVersionedDeploymentSpec.HOST_TYPE_CENTOSSERVERVersionedDeploymentSpec.HOST_TYPE_CENTOSKVM
type of host - host_version (
str) – version of the host - package_stores (
listofPackageStore) – Package store contains package url and bulletin_ids - service_vm_ovf_url (
listofstrorNone) – list of service vm ovf urls
-
HOST_TYPE_CENTOSKVM= 'CENTOSKVM'¶
-
HOST_TYPE_CENTOSSERVER= 'CENTOSSERVER'¶
-
HOST_TYPE_ESXI= 'ESXI'¶
-
HOST_TYPE_RHELCONTAINER= 'RHELCONTAINER'¶
-
HOST_TYPE_RHELKVM= 'RHELKVM'¶
-
HOST_TYPE_RHELSERVER= 'RHELSERVER'¶
-
HOST_TYPE_UBUNTUKVM= 'UBUNTUKVM'¶
-
HOST_TYPE_UBUNTUSERVER= 'UBUNTUSERVER'¶
- host_type (
-
class
com.vmware.nsx_policy.model_client.VidmInfo(display_name=None, name=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVidm Info
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - display_name (
strorNone) – User’s Full Name Or User Group’s Display Name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - name (
strorNone) – Username Or Groupname This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - type (
strorNone) –Possible values are:
TypeThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
TYPE_GROUP= 'remote_group'¶
-
TYPE_USER= 'remote_user'¶
- display_name (
-
class
com.vmware.nsx_policy.model_client.VidmInfoListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVidmInfo) – List results
- links (
-
class
com.vmware.nsx_policy.model_client.View(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, exclude_roles=None, include_roles=None, shared=None, weight=None, widgets=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDescribes the configuration of a view to be displayed on the dashboard.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - exclude_roles (
strorNone) – Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified. - include_roles (
strorNone) – Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. - shared (
boolorNone) – Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users. - weight (
longorNone) – Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order. format: int32 - widgets (
listofWidgetItem) – Array of widgets that are part of the view.
- links (
-
class
com.vmware.nsx_policy.model_client.VifAttachmentContext(app_id=None, parent_vif_id=None, traffic_tag=None, transport_node_uuid=None, vif_type=None, allocate_addresses=None, resource_type='VifAttachmentContext')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - app_id (
strorNone) – An application ID used to identify / look up a child VIF behind a parent VIF. Only effective when vif_type is CHILD. - parent_vif_id (
strorNone) – VIF ID of the parent VIF if vif_type is CHILD - traffic_tag (
longorNone) – Current we use VLAN id as the traffic tag. Only effective when vif_type is CHILD. Each logical port inside a container must have a unique traffic tag. If the traffic_tag is not unique, no error is generated, but traffic will not be delivered to any port with a non-unique tag. format: int32 - transport_node_uuid (
strorNone) – Only effective when vif_type is INDEPENDENT. Each logical port inside a bare metal server or container must have a transport node UUID. We use transport node ID as transport node UUID. - vif_type (
str) –Possible values are:
VifAttachmentContext.VIF_TYPE_PARENTVifAttachmentContext.VIF_TYPE_CHILDVifAttachmentContext.VIF_TYPE_INDEPENDENT
Type of the VIF attached to logical port - allocate_addresses (
strorNone) –Possible values are:
AttachmentContext.ALLOCATE_ADDRESSES_IPPOOLAttachmentContext.ALLOCATE_ADDRESSES_MACPOOLAttachmentContext.ALLOCATE_ADDRESSES_BOTHAttachmentContext.ALLOCATE_ADDRESSES_NONE
A flag to indicate whether to allocate addresses from allocation pools bound to the parent logical switch.
- resource_type (
str) – Used to identify which concrete class it is
-
VIF_TYPE_CHILD= 'CHILD'¶
-
VIF_TYPE_INDEPENDENT= 'INDEPENDENT'¶
-
VIF_TYPE_PARENT= 'PARENT'¶
- app_id (
-
class
com.vmware.nsx_policy.model_client.VirtualEndpoint(service_names=None, links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualEndpoint', tags=None, parent_path=None, path=None, relative_path=None, children=None, marked_for_delete=None, target_ips=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA VirtualEndpoint represents an IP (or nexthop) which is outside SDDC. It represents a redirection target for RedirectionPolicy.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - service_names (
listofstr) – One VirtualEndpoint will be created per service name. - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - parent_path (
strorNone) – Path of its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - path (
strorNone) – Absolute path of this object This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - relative_path (
strorNone) – Path relative from its parent This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - children (
listofChildPolicyConfigResourceorNone) – subtree for this type within policy tree containing nested elements. - marked_for_delete (
boolorNone) – Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - target_ips (
listofIPInfo) – IPs where either inbound or outbound traffic is to be redirected.
- service_names (
-
class
com.vmware.nsx_policy.model_client.VirtualEndpointListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructCollection of vitual endpoints under a tier-0
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVirtualEndpoint) – All virtual endpoints under a tier-0
- links (
-
class
com.vmware.nsx_policy.model_client.VirtualMachine(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, compute_ids=None, external_id=None, host_id=None, local_id_on_host=None, power_state=None, source=None, type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - last_sync_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - compute_ids (
listofstr) – List of external compute ids of the virtual machine in the format ‘id-type-key:value’ , list of external compute ids [‘uuid:xxxx-xxxx-xxxx-xxxx’, ‘moIdOnHost:moref-11’, ‘instanceUuid:xxxx-xxxx-xxxx-xxxx’] - external_id (
str) – Current external id of this virtual machine in the system. - host_id (
strorNone) – Id of the host in which this virtual machine exists. - local_id_on_host (
str) – Id of the vm unique within the host. - power_state (
str) –Possible values are:
VirtualMachine.POWER_STATE_VM_RUNNINGVirtualMachine.POWER_STATE_VM_STOPPEDVirtualMachine.POWER_STATE_VM_SUSPENDEDVirtualMachine.POWER_STATE_UNKNOWN
Current power state of this virtual machine in the system. - source (
ResourceReferenceorNone) – Reference of the Host or Public Cloud Gateway that reported the VM - type (
strorNone) –Possible values are:
Virtual Machine type; Edge, Service VM or other.This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
POWER_STATE_UNKNOWN= 'UNKNOWN'¶
-
POWER_STATE_VM_RUNNING= 'VM_RUNNING'¶
-
POWER_STATE_VM_STOPPED= 'VM_STOPPED'¶
-
POWER_STATE_VM_SUSPENDED= 'VM_SUSPENDED'¶
-
TYPE_EDGE= 'EDGE'¶
-
TYPE_REGULAR= 'REGULAR'¶
-
TYPE_SERVICE= 'SERVICE'¶
- links (
-
class
com.vmware.nsx_policy.model_client.VirtualMachineListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVirtualMachine) – VirtualMachine list results
- links (
-
class
com.vmware.nsx_policy.model_client.VirtualMachineTagsUpdate(tags=None, virtual_machine_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructList of tags applied to the virtual machine. Based on the enforcement point, the virtual_machine_id will be different. It could be an external id for NSX T or a moid for NSX V
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - tags (
listofTag) – List of tags to be applied on the virtual machine - virtual_machine_id (
str) – The identifier that is used in the enforcement point that uniquely identifies the virtual machine. In case of NSXT it would be the value of the external_id of the virtual machine.
- tags (
-
class
com.vmware.nsx_policy.model_client.VirtualNetworkInterface(links=None, schema=None, self_=None, last_sync_time=None, description=None, display_name=None, resource_type=None, tags=None, device_key=None, device_name=None, external_id=None, host_id=None, ip_address_info=None, lport_attachment_id=None, mac_address=None, owner_vm_id=None, vm_local_id_on_host=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - last_sync_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - device_key (
str) – Device key of the virtual network interface. - device_name (
strorNone) – Device name of the virtual network interface. - external_id (
str) – External Id of the virtual network inferface. - host_id (
str) – Id of the host on which the vm exists. - ip_address_info (
listofIpAddressInfoorNone) – IP Addresses of the the virtual network interface, from various sources. - lport_attachment_id (
strorNone) – LPort Attachment Id of the virtual network interface. - mac_address (
str) – MAC address of the virtual network interface. - owner_vm_id (
str) – Id of the vm to which this virtual network interface belongs. - vm_local_id_on_host (
str) – Id of the vm unique within the host.
- links (
-
class
com.vmware.nsx_policy.model_client.VirtualNetworkInterfaceElement(element_id=None, elements=None, resource_name=None, resource_type=None, device_key=None, device_name=None, ip_addresses=None, mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtual Network Interface extends from Element class. This class contains vnic information of a VM.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - element_id (
strorNone) – Unique identifier of the element - elements (
listofElementorNone) – An element can contain an array of elements. For ex, a group element can contain an array of VMs belonging to the group or an array of processes running inside the VM belonging to the group. - resource_name (
strorNone) – Resource name of the element - resource_type (
strorNone) –Possible values are:
VirtualNetworkInterfaceElement.RESOURCE_TYPE_VMELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_GROUPELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_PROCESSELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOGICALSWITCHELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOGICALT0ROUTERELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOGICALT1ROUTERELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOGICALSWITCHPORTELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOGICALROUTERPORTELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_HOSTNODEELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_EDGENODEELEMENTVirtualNetworkInterfaceElement.RESOURCE_TYPE_LOADBALANCERSERVICEELEMENTResource type of the element
- device_key (
strorNone) – Device key of virtual network interface This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - device_name (
strorNone) – Device name of virtual network interface This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - ip_addresses (
listofstrorNone) – IP Addresses of virtual network interface This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - mac_address (
strorNone) – MAC address of virtual network interface This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
RESOURCE_TYPE_EDGENODEELEMENT= 'EdgeNodeElement'¶
-
RESOURCE_TYPE_GROUPELEMENT= 'GroupElement'¶
-
RESOURCE_TYPE_HOSTNODEELEMENT= 'HostNodeElement'¶
-
RESOURCE_TYPE_LBVIRTUALSERVERELEMENT= 'LBVirtualServerElement'¶
-
RESOURCE_TYPE_LOADBALANCERSERVICEELEMENT= 'LoadBalancerServiceElement'¶
-
RESOURCE_TYPE_LOGICALROUTERPORTELEMENT= 'LogicalRouterPortElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHELEMENT= 'LogicalSwitchElement'¶
-
RESOURCE_TYPE_LOGICALSWITCHPORTELEMENT= 'LogicalSwitchPortElement'¶
-
RESOURCE_TYPE_LOGICALT0ROUTERELEMENT= 'LogicalT0RouterElement'¶
-
RESOURCE_TYPE_LOGICALT1ROUTERELEMENT= 'LogicalT1RouterElement'¶
-
RESOURCE_TYPE_PROCESSELEMENT= 'ProcessElement'¶
-
RESOURCE_TYPE_VIRTUALNETWORKINTERFACEELEMENT= 'VirtualNetworkInterfaceElement'¶
-
RESOURCE_TYPE_VMELEMENT= 'VMElement'¶
- element_id (
-
class
com.vmware.nsx_policy.model_client.VirtualNetworkInterfaceListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVirtualNetworkInterface) – VirtualNetworkInterface list results
- links (
-
class
com.vmware.nsx_policy.model_client.VirtualServiceInstance(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='VirtualServiceInstance', tags=None, on_failure_policy=None, service_id=None, transport_type=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVirtualServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s and the user is not bringing their own appliance (BYOD).
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
BaseServiceInstance.RESOURCE_TYPE_SERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_BYODSERVICEINSTANCEBaseServiceInstance.RESOURCE_TYPE_VIRTUALSERVICEINSTANCE
ServiceInstance is used when NSX handles the lifecyle of appliance. Deployment and appliance related all the information is necessary. ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX. VirtualServiceInstance is a a custom instance to be used when NSX is not handling the lifecycle of an appliance and when the user is not bringing their own appliance.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - on_failure_policy (
strorNone) –Possible values are:
Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.
- service_id (
strorNone) – The Service to which the service instance is associated. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - transport_type (
str) –Possible values are:
Transport to be used by this service instance for deploying the Service-VM.
- links (
-
class
com.vmware.nsx_policy.model_client.VlanMirrorSource(vlan_ids=None, resource_type='VlanMirrorSource')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - vlan_ids (
listoflong) – Source VLAN ID list format: int64 - resource_type (
str) –Possible values are:
MirrorSource.RESOURCE_TYPE_LOGICALPORTMIRRORSOURCEMirrorSource.RESOURCE_TYPE_PNICMIRRORSOURCEMirrorSource.RESOURCE_TYPE_VLANMIRRORSOURCEMirrorSource.RESOURCE_TYPE_LOGICALSWITCHMIRRORSOURCE
Resource types of mirror source
- vlan_ids (
-
class
com.vmware.nsx_policy.model_client.VlanTrunkSpec(vlan_ranges=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructVlanTrunkspec is used for specifying trunk VLAN id ranges.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: vlan_ranges ( listofTrunkVlanRange) – Trunk VLAN id ranges
-
class
com.vmware.nsx_policy.model_client.VmNicInfo(nic_infos=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructContains a set of information of a VM on the network interfaces present on the partner appliance that needs to be configured by the NSX Manager.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: nic_infos ( listofNicInfo) – Set of information of a VM on the network interfaces present on the partner appliance that needs to be configured by the NSX Manager.
-
class
com.vmware.nsx_policy.model_client.VmkToLogicalSwitchMapping(dest_network_id=None, src_interface_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructHolds VMkernal to logical switch mapping. This will be used for network migration.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - dest_network_id (
str) – Only VLAN type of logical switch can be specified here, as migration operation is only supported for these types. - src_interface_id (
str) – The ID (for example, vmk0) of the vmkernal interface on ESX to migrate.
- dest_network_id (
-
class
com.vmware.nsx_policy.model_client.VniPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, ranges=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - ranges (
listofVniRange) – VNI range list results
- links (
-
class
com.vmware.nsx_policy.model_client.VniPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVniPool) – VNI pool list results
- links (
-
class
com.vmware.nsx_policy.model_client.VniRange(links=None, schema=None, self_=None, end=None, start=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA range of virtual network identifiers (VNIs)
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - end (
long) – End value for vni range to be used for virtual networks format: int64 - start (
long) – Start value for vni range to be used for virtual networks format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.VsphereClusterNodeVMDeploymentConfig(allow_ssh_root_login=None, compute_id=None, default_gateway_addresses=None, dns_servers=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, ntp_servers=None, storage_id=None, vc_id=None, placement_type='VsphereClusterNodeVMDeploymentConfig')¶ Bases:
vmware.vapi.bindings.struct.VapiStructConfig for deploying a cluster node VM through a Vcenter server
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - allow_ssh_root_login (
boolorNone) – If true, the root user will be allowed to log into the VM. Allowing root SSH logins is not recommended for security reasons. - compute_id (
str) – The cluster node VM will be deployed on the specified cluster or resourcepool for specified VC server. - default_gateway_addresses (
listofstrorNone) – The default gateway for the VM to be deployed must be specified if all the other VMs it communicates with are not in the same subnet. Do not specify this field and management_port_subnets to use DHCP. Note: only single IPv4 default gateway address is supported and it must belong to management network. IMPORTANT: Controllers deployed using DHCP are currently not supported, so this parameter should be specified for deploying Controllers. format: ip - dns_servers (
listofstrorNone) – List of DNS servers. If DHCP is used, the default DNS servers associated with the DHCP server will be used instead. format: ipv4 - enable_ssh (
boolorNone) – If true, the SSH service will automatically be started on the VM. Enabling SSH service is not recommended for security reasons. - host_id (
strorNone) – The cluster node VM will be deployed on the specified host in the specified VC server within the cluster if host_id is specified. Note: User must ensure that storage and specified networks are accessible by this host. - hostname (
str) – Desired host name/FQDN for the VM to be deployed - management_network_id (
str) – Distributed portgroup identifier to which the management vnic of cluster node VM will be connected. - management_port_subnets (
listofIPSubnetorNone) – IP Address and subnet configuration for the management port. Do not specify this field and default_gateway_addresses to use DHCP. Note: only one IPv4 address is supported for the management port. IMPORTANT: Controllers deployed using DHCP are currently not supported, so this parameter should be specified for deploying Controllers. - ntp_servers (
listofstrorNone) – List of NTP servers. To use hostnames, a DNS server must be defined. If not using DHCP, a DNS server should be specified under dns_servers. format: hostname-or-ipv4 - storage_id (
str) – The cluster node VM will be deployed on the specified datastore in the specified VC server. User must ensure that storage is accessible by the specified cluster/host. - vc_id (
str) – The VC-specific identifiers will be resolved on this VC, so all other identifiers specified in the config must belong to this Vcenter server. - placement_type (
str) –Possible values are:
Specifies the config for the platform through which to deploy the VM
- allow_ssh_root_login (
-
class
com.vmware.nsx_policy.model_client.VsphereDeploymentConfig(allow_ssh_root_login=None, compute_id=None, data_network_ids=None, default_gateway_addresses=None, dns_servers=None, enable_ssh=None, host_id=None, hostname=None, management_network_id=None, management_port_subnets=None, ntp_servers=None, search_domains=None, storage_id=None, vc_id=None, placement_type='VsphereDeploymentConfig')¶ Bases:
vmware.vapi.bindings.struct.VapiStructThe Vsphere deployment configuration determines where to deploy the edge node. It contains settings that are applied during install time. If using DHCP, you must leave the following fields unset: search_domains, management_port_subnets, dns_servers and default_gateway_addresses.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - allow_ssh_root_login (
boolorNone) – Allowing root SSH logins is not recommended for security reasons. - compute_id (
str) – The edge node vm will be deployed on the specified cluster or resourcepool. Note - all the hosts must have nsx fabric prepared in the specified cluster. - data_network_ids (
listofstr) – List of distributed portgroup or VLAN logical identifiers to which the datapath serving vnics of edge node vm will be connected. - default_gateway_addresses (
listofstrorNone) – The default gateway for edge node must be specified if all the nodes it communicates with are not in the same subnet. Note: Only single IPv4 default gateway address is supported and it must belong to management network. format: ip - dns_servers (
listofstrorNone) – List of DNS servers. format: ip - enable_ssh (
boolorNone) – Enabling SSH service is not recommended for security reasons. - host_id (
strorNone) – The edge node vm will be deployed on the specified Host within the cluster if host_id is specified. Note - User must ensure that storage and specified networks are accessible by this host. - hostname (
str) – Host name or FQDN for edge node. - management_network_id (
str) – Distributed portgroup identifier to which the management vnic of edge node vm will be connected. This portgroup must have connectivity with MP and CCP. A VLAN logical switch identifier may also be specified. - management_port_subnets (
listofIPSubnetorNone) – IP Address and subnet configuration for the management port. Note: only one IPv4 address is supported for the management port. - ntp_servers (
listofstrorNone) – List of NTP servers. format: ip - search_domains (
listofstrorNone) – List of domain names that are used to complete unqualified host names. - storage_id (
str) – The edge node vm will be deployed on the specified datastore. User must ensure that storage is accessible by the specified cluster/host. - vc_id (
str) – The vc specific identifiers will be resolved on this VC. So all other identifiers specified here must belong to this vcenter server. - placement_type (
str) –Possible values are:
- allow_ssh_root_login (
-
class
com.vmware.nsx_policy.model_client.VtepCsvListResult(file_name=None, last_update_timestamp=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - file_name (
strorNone) – File name set by HTTP server if API returns CSV result as a file. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVtepTableCsvRecordorNone) –
- file_name (
-
class
com.vmware.nsx_policy.model_client.VtepLabelPool(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type=None, tags=None, pool_usage=None, ranges=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA collection of ranges of virtual tunnel endpoint labels
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
strorNone) – Defaults to ID if not set - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
strorNone) – The type of this resource. - tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - pool_usage (
VtepLabelPoolUsageorNone) – Pool usage statistics - ranges (
listofVtepLabelRange) – Array of ranges for virtual tunnel endpoint labels
- links (
-
class
com.vmware.nsx_policy.model_client.VtepLabelPoolListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, results=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVtepLabelPool) – Virtual tunnel endpoint label pool list results
- links (
-
class
com.vmware.nsx_policy.model_client.VtepLabelPoolUsage(allocated_ids=None, free_ids=None, total_ids=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructPool usage statistics in a pool
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - allocated_ids (
longorNone) – Total number of allocated IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - free_ids (
longorNone) – Total number of free IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - total_ids (
longorNone) – Total number of IDs in a pool format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- allocated_ids (
-
class
com.vmware.nsx_policy.model_client.VtepLabelRange(links=None, schema=None, self_=None, end=None, start=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - end (
long) – End value for virtual tunnel endpoint label range format: int64 - start (
long) – Start value for virtual tunnel endpoint label range format: int64
- links (
-
class
com.vmware.nsx_policy.model_client.VtepListResult(links=None, schema=None, self_=None, cursor=None, result_count=None, sort_ascending=None, sort_by=None, last_update_timestamp=None, logical_switch_id=None, results=None, transport_node_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - result_count (
longorNone) – Count of results found (across all pages), set only on first page format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_ascending (
boolorNone) – If true, results are sorted in ascending order This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - sort_by (
strorNone) – Field by which records are sorted This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_update_timestamp (
longorNone) – Timestamp when the data was last updated; unset if data source has never updated the data. format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - logical_switch_id (
strorNone) – The id of the logical Switch This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - results (
listofVtepTableEntryorNone) – - transport_node_id (
strorNone) – Transport node identifier This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- links (
-
class
com.vmware.nsx_policy.model_client.VtepTableCsvRecord(segment_id=None, vtep_ip=None, vtep_label=None, vtep_mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - segment_id (
strorNone) – The segment Id - vtep_ip (
strorNone) – The virtual tunnel endpoint IP address format: ip - vtep_label (
long) – The virtual tunnel endpoint label format: int64 - vtep_mac_address (
str) – The virtual tunnel endpoint MAC address
- segment_id (
-
class
com.vmware.nsx_policy.model_client.VtepTableEntry(segment_id=None, vtep_ip=None, vtep_label=None, vtep_mac_address=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - segment_id (
strorNone) – The segment Id - vtep_ip (
strorNone) – The virtual tunnel endpoint IP address format: ip - vtep_label (
longorNone) – The virtual tunnel endpoint label format: int64 - vtep_mac_address (
strorNone) – The virtual tunnel endpoint MAC address
- segment_id (
-
class
com.vmware.nsx_policy.model_client.WeeklyBackupSchedule(days_of_week=None, hour_of_day=None, minute_of_day=None, resource_type='WeeklyBackupSchedule')¶ Bases:
vmware.vapi.bindings.struct.VapiStructSchedule to specify day of the week and time to take automated backup
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - days_of_week (
listoflong) – Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday … format: int64 - hour_of_day (
long) – Time of day when backup is taken format: int64 - minute_of_day (
long) – Time of day when backup is taken format: int64 - resource_type (
str) –Possible values are:
BackupSchedule.RESOURCE_TYPE_WEEKLYBACKUPSCHEDULEBackupSchedule.RESOURCE_TYPE_INTERVALBACKUPSCHEDULE
Schedule type
- days_of_week (
-
class
com.vmware.nsx_policy.model_client.WeeklyTelemetrySchedule(day_of_week=None, hour_of_day=None, minutes=None, frequency_type='WeeklyTelemetrySchedule')¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - day_of_week (
str) –Possible values are:
WeeklyTelemetrySchedule.DAY_OF_WEEK_SUNDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_MONDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_TUESDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_WEDNESDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_THURSDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_FRIDAYWeeklyTelemetrySchedule.DAY_OF_WEEK_SATURDAY
Day of week on which data will be collected. Specify one of SUNDAY through SATURDAY.
- hour_of_day (
long) – Hour at which data will be collected. Specify a value between 0 through 23. format: int64 - minutes (
longorNone) – Minute at which data will be collected. Specify a value between 0 through 59. format: int64 - frequency_type (
str) – Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.
-
DAY_OF_WEEK_FRIDAY= 'FRIDAY'¶
-
DAY_OF_WEEK_MONDAY= 'MONDAY'¶
-
DAY_OF_WEEK_SATURDAY= 'SATURDAY'¶
-
DAY_OF_WEEK_SUNDAY= 'SUNDAY'¶
-
DAY_OF_WEEK_THURSDAY= 'THURSDAY'¶
-
DAY_OF_WEEK_TUESDAY= 'TUESDAY'¶
-
DAY_OF_WEEK_WEDNESDAY= 'WEDNESDAY'¶
- day_of_week (
-
class
com.vmware.nsx_policy.model_client.WidgetConfiguration(links=None, schema=None, self_=None, revision=None, create_time=None, create_user=None, last_modified_time=None, last_modified_user=None, protection=None, system_owned=None, description=None, display_name=None, id=None, resource_type='WidgetConfiguration', tags=None, datasources=None, drilldown_id=None, footer=None, is_drilldown=None, shared=None, weight=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructDescribes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - links (
listofResourceLinkorNone) – The server will populate this field when returing the resource. Ignored on PUT and POST. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - schema (
strorNone) – Schema for this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - self (
SelfResourceLinkorNone) – Link to this resource - revision (
longorNone) – The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32 - create_time (
longorNone) – Timestamp of resource creation format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - create_user (
strorNone) – ID of the user who created this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_time (
longorNone) – Timestamp of last modification format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - last_modified_user (
strorNone) – ID of the user who last modified this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - protection (
strorNone) – Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - system_owned (
boolorNone) – Indicates system owned resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - description (
strorNone) – Description of this resource - display_name (
str) – Title of the widget. - id (
strorNone) – Unique identifier of this resource This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - resource_type (
str) –Possible values are:
WidgetConfiguration.RESOURCE_TYPE_LABELVALUECONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_DONUTCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_MULTIWIDGETCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_CONTAINERCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_STATSCONFIGURATIONWidgetConfiguration.RESOURCE_TYPE_GRIDCONFIGURATION
Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.
- tags (
listofTagorNone) – Opaque identifiers meaningful to the API user - datasources (
listofDatasourceorNone) – The ‘datasources’ represent the sources from which data will be fetched. Currently, only NSX-API is supported as a ‘default’ datasource. An example of specifying ‘default’ datasource along with the urls to fetch data from is given at ‘example_request’ section of ‘CreateWidgetConfiguration’ API. - drilldown_id (
strorNone) – Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget. - footer (
FooterorNone) – - is_drilldown (
boolorNone) – Set to true if this widget should be used as a drilldown. - shared (
boolorNone) – Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. - weight (
longorNone) – Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. format: int32
-
RESOURCE_TYPE_CONTAINERCONFIGURATION= 'ContainerConfiguration'¶
-
RESOURCE_TYPE_DONUTCONFIGURATION= 'DonutConfiguration'¶
-
RESOURCE_TYPE_GRIDCONFIGURATION= 'GridConfiguration'¶
-
RESOURCE_TYPE_LABELVALUECONFIGURATION= 'LabelValueConfiguration'¶
-
RESOURCE_TYPE_MULTIWIDGETCONFIGURATION= 'MultiWidgetConfiguration'¶
-
RESOURCE_TYPE_STATSCONFIGURATION= 'StatsConfiguration'¶
- links (
-
class
com.vmware.nsx_policy.model_client.WidgetItem(label=None, weight=None, widget_id=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructRepresents a reference to a widget that is held by a container or a multi-widget or a View.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - label (
LabelorNone) – Applicable for ‘DonutConfiguration’ and ‘StatsConfiguration’ reports only. If label is not specified, then it defaults to the label of the donut or stats report. - weight (
longorNone) – Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order. format: int32 - widget_id (
str) – Id of the widget configuration that is held by a multi-widget or a container or a view.
- label (
-
class
com.vmware.nsx_policy.model_client.X509Certificate(dsa_public_keyg=None, dsa_public_keyp=None, dsa_public_keyq=None, dsa_public_keyy=None, is_ca=None, is_valid=None, issuer=None, issuer_cn=None, not_after=None, not_before=None, public_key_algo=None, public_key_length=None, rsa_public_key_exponent=None, rsa_public_key_modulus=None, serial_number=None, signature=None, signature_algorithm=None, subject=None, subject_cn=None, version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructTip
The arguments are used to initialize data attributes with the same names.
Parameters: - dsa_public_keyg (
strorNone) – One of the DSA cryptogaphic algorithm’s strength parameters, base This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dsa_public_keyp (
strorNone) – One of the DSA cryptogaphic algorithm’s strength parameters, prime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dsa_public_keyq (
strorNone) – One of the DSA cryptogaphic algorithm’s strength parameters, sub-prime This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - dsa_public_keyy (
strorNone) – One of the DSA cryptogaphic algorithm’s strength parameters This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_ca (
boolorNone) – True if this is a CA certificate This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - is_valid (
boolorNone) – True if this certificate is valid This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - issuer (
strorNone) – the certificate issuers complete distinguished name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - issuer_cn (
strorNone) – the certificate issuer’s common name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - not_after (
longorNone) – the time in epoch milliseconds at which the certificate becomes invalid format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - not_before (
longorNone) – the time in epoch milliseconds at which the certificate becomes valid format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - public_key_algo (
strorNone) –Possible values are:
Cryptographic algorithm used by the public key for data encryptionThis attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- public_key_length (
longorNone) – size measured in bits of the public/private keys used in a cryptographic algorithm format: int64 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rsa_public_key_exponent (
strorNone) – An RSA public key is made up of the modulus and the public exponent. Exponent is a power number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - rsa_public_key_modulus (
strorNone) – An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - serial_number (
strorNone) – certificate’s serial number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - signature (
strorNone) – the signature value(the raw signature bits) used for signing and validate the cert This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - signature_algorithm (
strorNone) – the algorithm used by the Certificate Authority to sign the certificate This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subject (
strorNone) – the certificate owners complete distinguished name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - subject_cn (
strorNone) – the certificate owner’s common name This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - version (
strorNone) – Certificate version (default v1) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
PUBLIC_KEY_ALGO_DSA= 'DSA'¶
-
PUBLIC_KEY_ALGO_RSA= 'RSA'¶
- dsa_public_keyg (
-
class
com.vmware.nsx_policy.model_client.X509Crl(crl_entries=None, issuer=None, next_update=None, version=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructA CRL is a time-stamped list identifying revoked certificates.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - crl_entries (
listofX509CrlEntryorNone) – list of X509CrlEntry This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - issuer (
strorNone) – Issuer’s distinguished name(DN) This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - next_update (
strorNone) – Next update time for the CRL This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - version (
strorNone) – CRL’s version number either 1 or 2 This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- crl_entries (
-
class
com.vmware.nsx_policy.model_client.X509CrlEntry(revocation_date=None, serial_number=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStructEach revoked certificate is identified in a CRL by its certificate serial number.
Tip
The arguments are used to initialize data attributes with the same names.
Parameters: - revocation_date (
strorNone) – Revocation date This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored. - serial_number (
strorNone) – the revoked certificate’s serial number This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
- revocation_date (
com.vmware.nsx_policy.tasks_client module¶
-
class
com.vmware.nsx_policy.tasks_client.Response(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(task_id)¶ Get the response of a task
Parameters: task_id ( str) – ID of task to read (required)Return type: vmware.vapi.struct.VapiStructReturns: DynamicStructure Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.tasks_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.telemetry_client module¶
-
class
com.vmware.nsx_policy.telemetry_client.Agreement(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Returns telemetry agreement information.
Return type: com.vmware.nsx_policy.model_client.TelemetryAgreementReturns: com.vmware.nsx_policy.model.TelemetryAgreement Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
update(telemetry_agreement)¶ Set telemetry agreement information.
Parameters: telemetry_agreement ( com.vmware.nsx_policy.model_client.TelemetryAgreement) – (required)Return type: com.vmware.nsx_policy.model_client.TelemetryAgreementReturns: com.vmware.nsx_policy.model.TelemetryAgreement Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.telemetry_client.Config(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get()¶ Returns the telemetry configuration.
Return type: com.vmware.nsx_policy.model_client.TelemetryConfigReturns: com.vmware.nsx_policy.model.TelemetryConfig Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
update(telemetry_config)¶ Updates or creates the telemetry configuration, and returns the new configuration.
Parameters: telemetry_config ( com.vmware.nsx_policy.model_client.TelemetryConfig) – (required)Return type: com.vmware.nsx_policy.model_client.TelemetryConfigReturns: com.vmware.nsx_policy.model.TelemetryConfig Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.telemetry_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.trust_management_client module¶
-
class
com.vmware.nsx_policy.trust_management_client.Certificates(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
LIST_TYPE_CERTIFICATE= 'cluster_api_certificate'¶ Possible value for
typeof methodCertificates.list().
-
delete(cert_id)¶ Removes the specified certificate. The private key associated with the certificate is also deleted.
Parameters: cert_id ( str) – ID of certificate to delete (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(cert_id, details=None)¶ Returns information for the specified certificate ID, including the certificate’s UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - cert_id (
str) – ID of certificate to read (required) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false)
Return type: Returns: com.vmware.nsx_policy.model.Certificate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cert_id (
-
importcertificate(trust_object_data)¶ Adds a new private-public certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to one of the user-facing components (appliance management or edge). The certificate and the key should be stored in PEM format. If no private key is provided, the certificate is used as a client certificate in the trust store.
Parameters: trust_object_data ( com.vmware.nsx_policy.model_client.TrustObjectData) – (required)Return type: com.vmware.nsx_policy.model_client.CertificateListReturns: com.vmware.nsx_policy.model.CertificateList Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶ Returns all certificate information viewable by the user, including each certificate’s UUID; resource_type (for example, certificate_self_signed, certificate_ca, or certificate_signed); pem_encoded data; and history of the certificate (who created or modified it and when). For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional) - type (
strorNone) – Type of certificate to return (optional)
Return type: Returns: com.vmware.nsx_policy.model.CertificateList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
-
class
com.vmware.nsx_policy.trust_management_client.Crls(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
LIST_TYPE_CERTIFICATE= 'cluster_api_certificate'¶ Possible value for
typeof methodCrls.list().
-
delete(crl_id)¶ Deletes an existing CRL.
Parameters: crl_id ( str) – ID of CRL to delete (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(crl_id, details=None)¶ Returns information about the specified CRL. For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - crl_id (
str) – ID of CRL to read (required) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false)
Return type: Returns: com.vmware.nsx_policy.model.Crl
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- crl_id (
-
importcrl(crl_object_data)¶ Adds a new certificate revocation list (CRL). The CRL is used to verify the client certificate status against the revocation lists published by the CA. For this reason, the administrator needs to add the CRL in certificate repository as well.
Parameters: crl_object_data ( com.vmware.nsx_policy.model_client.CrlObjectData) – (required)Return type: com.vmware.nsx_policy.model_client.CrlListReturns: com.vmware.nsx_policy.model.CrlList Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list(cursor=None, details=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None, type=None)¶ Returns information about all CRLs. For additional information, include the ?details=true modifier at the end of the request URI.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - details (
boolorNone) – whether to expand the pem data and show all its details (optional, default to false) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional) - type (
strorNone) – Type of certificate to return (optional)
Return type: Returns: com.vmware.nsx_policy.model.CrlList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
update(crl_id, crl)¶ Updates an existing CRL.
Parameters: - crl_id (
str) – ID of CRL to update (required) - crl (
com.vmware.nsx_policy.model_client.Crl) – (required)
Return type: Returns: com.vmware.nsx_policy.model.Crl
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- crl_id (
-
-
class
com.vmware.nsx_policy.trust_management_client.Csrs(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
create(csr)¶ Creates a new certificate signing request (CSR). A CSR is encrypted text that contains information about your organization (organization name, country, and so on) and your Web server’s public key, which is a public certificate the is generated on the server that can be used to forward this request to a certificate authority (CA). A private key is also usually created at the same time as the CSR.
Parameters: csr ( com.vmware.nsx_policy.model_client.Csr) – (required)Return type: com.vmware.nsx_policy.model_client.CsrReturns: com.vmware.nsx_policy.model.Csr Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
delete(csr_id)¶ Removes a specified CSR. If a CSR is not used for verification, you can delete it. Note that the CSR import and upload POST actions automatically delete the associated CSR.
Parameters: csr_id ( str) – ID of CSR to delete (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(csr_id)¶ Returns information about the specified CSR.
Parameters: csr_id ( str) – ID of CSR to read (required)Return type: com.vmware.nsx_policy.model_client.CsrReturns: com.vmware.nsx_policy.model.Csr Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
importcsr(csr_id, trust_object_data)¶ Imports a certificate authority (CA)-signed certificate for a CSR. This action links the certificate to the private key created by the CSR. The pem_encoded string in the request body is the signed certificate provided by your CA in response to the CSR that you provide to them. The import POST action automatically deletes the associated CSR.
Parameters: - csr_id (
str) – CSR this certificate is associated with (required) - trust_object_data (
com.vmware.nsx_policy.model_client.TrustObjectData) – (required)
Return type: Returns: com.vmware.nsx_policy.model.CertificateList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- csr_id (
-
list(cursor=None, included_fields=None, page_size=None, sort_ascending=None, sort_by=None)¶ Returns information about all of the CSRs that have been created.
Parameters: - cursor (
strorNone) – Opaque cursor to be used for getting next page of records (supplied by current result page) (optional) - included_fields (
strorNone) – Comma separated list of fields that should be included in query result (optional) - page_size (
longorNone) – Maximum number of results to return in this page (server may return fewer) (optional, default to 1000) - sort_ascending (
boolorNone) – (optional) - sort_by (
strorNone) – Field by which records are sorted (optional)
Return type: Returns: com.vmware.nsx_policy.model.CsrList
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- cursor (
-
selfsign(csr_id, days_valid)¶ Self-signs the previously generated CSR. This action is similar to the import certificate action, but instead of using a public certificate signed by a CA, the self_sign POST action uses a certificate that is signed with NSX’s own private key.
Parameters: - csr_id (
str) – CSR this certificate is associated with (required) - days_valid (
long) – Number of days the certificate will be valid, default 10 years (required)
Return type: Returns: com.vmware.nsx_policy.model.Certificate
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- csr_id (
-
-
class
com.vmware.nsx_policy.trust_management_client.PrincipalIdentities(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
create(principal_identity)¶ Associates a principal’s name with a certificate that is used to authenticate.
Parameters: principal_identity ( com.vmware.nsx_policy.model_client.PrincipalIdentity) – (required)Return type: com.vmware.nsx_policy.model_client.PrincipalIdentityReturns: com.vmware.nsx_policy.model.PrincipalIdentity Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
delete(principal_identity_id)¶ Delete a principal identity. It does not delete the certificate.
Parameters: principal_identity_id ( str) – Unique id of the principal identity to delete (required)Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
get(principal_identity_id)¶ Get a stored principal identity
Parameters: principal_identity_id ( str) – ID of Principal Identity to get (required)Return type: com.vmware.nsx_policy.model_client.PrincipalIdentityReturns: com.vmware.nsx_policy.model.PrincipalIdentity Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list()¶ Returns the list of principals registered with a certificate.
Return type: com.vmware.nsx_policy.model_client.PrincipalIdentityListReturns: com.vmware.nsx_policy.model.PrincipalIdentityList Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
updatecertificate(update_principal_identity_certificate_request)¶ Update a principal identity’s certificate
Parameters: update_principal_identity_certificate_request ( com.vmware.nsx_policy.model_client.UpdatePrincipalIdentityCertificateRequest) – (required)Return type: com.vmware.nsx_policy.model_client.PrincipalIdentityReturns: com.vmware.nsx_policy.model.PrincipalIdentity Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
-
class
com.vmware.nsx_policy.trust_management_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
com.vmware.nsx_policy.upgrade_client module¶
-
class
com.vmware.nsx_policy.upgrade_client.StubFactory(stub_config)¶ Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
Parameters: stub_config ( vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
-
class
com.vmware.nsx_policy.upgrade_client.VersionWhitelist(config)¶ Bases:
vmware.vapi.bindings.stub.VapiInterfaceParameters: config ( vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
get(component_type)¶ Get whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP
Parameters: component_type ( str) – (required)Return type: com.vmware.nsx_policy.model_client.AcceptableComponentVersionReturns: com.vmware.nsx_policy.model.AcceptableComponentVersion Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
list()¶ Get whitelist of versions for different components
Return type: com.vmware.nsx_policy.model_client.AcceptableComponentVersionListReturns: com.vmware.nsx_policy.model.AcceptableComponentVersionList Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found
-
update(component_type, version_list)¶ Update the version whitelist for the specified component type (HOST, EDGE, CCP, MP).
Parameters: - component_type (
str) – (required) - version_list (
com.vmware.nsx_policy.model_client.VersionList) – (required)
Raise: com.vmware.vapi.std.errors_client.ServiceUnavailableService UnavailableRaise: com.vmware.vapi.std.errors_client.InvalidRequestBad Request, Precondition FailedRaise: com.vmware.vapi.std.errors_client.InternalServerErrorInternal Server ErrorRaise: com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFoundNot Found- component_type (
-